-
Notifications
You must be signed in to change notification settings - Fork 84
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: trends api #697
chore: trends api #697
Conversation
WalkthroughThe Changes
Sequence Diagram(s) (Beta)sequenceDiagram
participant User
participant API
participant Database
User->>API: GET /downloads/range/:start::end/:pkgName
API->>Database: Fetch download trends for :pkgName between :start and :end
Database-->>API: Return download trends data
API-->>User: Return download trends response
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/registry-api.md (2 hunks)
Additional context used
LanguageTool
docs/registry-api.md
[misspelling] ~85-~85: Use βanβ instead of βaβ if the following word starts with a vowel sound, e.g.Β βan articleβ, βan hourβ.
Context: ...-package) * [List packages since from a update time](/docs/registry-api.md#list...
[misspelling] ~607-~607: Use βanβ instead of βaβ if the following word starts with a vowel sound, e.g.Β βan articleβ, βan hourβ.
Context: ...rue }### List packages since from a update time
GET /-/all/since?stale...
[uncategorized] ~713-~713: Possible missing preposition found.
Context: ....1": "latest" } } }### List package names by users
bash GET /-/by-user/...
[style] ~719-~719: Itβs more common nowadays to write this noun as one word.
Context: ...ther1[|$another2...]] ``` *username
user name like `fengmk2` * also support multi use...
[uncategorized] ~719-~719: The common word order is βalso likeβ.
Context: ...other2...]] ``` *username
user name like `fengmk2` * also support multi users by `name1|name2|nam...
[misspelling] ~755-~755: Use βanβ instead of βaβ if the following word starts with a vowel sound, e.g.Β βan articleβ, βan hourβ.
Context: ...gistry-api.md#add-a-new-user) - [Update a exists user](/docs/registry-api.md#upda...
[misspelling] ~932-~932: Use βanβ instead of βaβ if the following word starts with a vowel sound, e.g.Β βan articleβ, βan hourβ.
Context: ...ent update conflict." } ``` ### Update a exists user * Authentication required....
Markdownlint
docs/registry-api.md
752-752: Expected: asterisk; Actual: dash
Unordered list style
753-753: Expected: asterisk; Actual: dash
Unordered list style
754-754: Expected: asterisk; Actual: dash
Unordered list style
755-755: Expected: asterisk; Actual: dash
Unordered list style
971-971: Expected: asterisk; Actual: dash
Unordered list style
972-972: Expected: asterisk; Actual: dash
Unordered list style
973-973: Expected: asterisk; Actual: dash
Unordered list style
60-60: null
Dollar signs used before commands without showing output
66-66: null
Dollar signs used before commands without showing output
618-618: null
Dollar signs used before commands without showing output
725-725: null
Dollar signs used before commands without showing output
726-726: null
Dollar signs used before commands without showing output
983-983: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
994-994: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
1008-1008: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
1015-1015: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
1018-1018: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
984-984: null
Fenced code blocks should be surrounded by blank lines
995-995: null
Fenced code blocks should be surrounded by blank lines
1019-1019: null
Fenced code blocks should be surrounded by blank lines
1009-1009: null
Lists should be surrounded by blank lines
255-255: null
Emphasis used instead of a heading
96-96: null
Fenced code blocks should have a language specified
257-257: null
Fenced code blocks should have a language specified
345-345: null
Fenced code blocks should have a language specified
457-457: null
Fenced code blocks should have a language specified
483-483: null
Fenced code blocks should have a language specified
517-517: null
Fenced code blocks should have a language specified
569-569: null
Fenced code blocks should have a language specified
587-587: null
Fenced code blocks should have a language specified
593-593: null
Fenced code blocks should have a language specified
609-609: null
Fenced code blocks should have a language specified
761-761: null
Fenced code blocks should have a language specified
801-801: null
Fenced code blocks should have a language specified
888-888: null
Fenced code blocks should have a language specified
936-936: null
Fenced code blocks should have a language specified
979-979: null
Fenced code blocks should have a language specified
1011-1011: null
Fenced code blocks should have a language specified
1036-1036: null
Fenced code blocks should have a language specified
1046-1046: null
Fenced code blocks should have a language specified
Additional comments not posted (1)
docs/registry-api.md (1)
11-12
: The addition of the[Token](/docs/registry-api.md#token)
and[Trend](/docs/registry-api.md#trend)
sections in the table of contents is well-placed and enhances the navigability of the document.
Codecov ReportAll modified and coverable lines are covered by tests β
Additional details and impacted files@@ Coverage Diff @@
## master #697 +/- ##
=======================================
Coverage 96.80% 96.80%
=======================================
Files 181 181
Lines 18026 18026
Branches 2343 2341 -2
=======================================
Hits 17450 17450
Misses 576 576 β View full report in Codecov by Sentry. |
```json | ||
HTTP/1.1 200 OK | ||
|
||
// /downloads/range/2024-01-01:2024-12-31/cnpmcore |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary by CodeRabbit
[Token]
and[Trend]
in the Registry API documentation.GET /downloads/range/:start::end/:pkgName
for fetching package download trends.Trend
endpoint.