github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-04-28 03:01:47 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2779 from atom/document-atom-io-pagination

Browse Source 
Document pagination for atom.io/api/packages
This commit is contained in:
Kevin Sawicki
2014-07-22 08:44:48 -07:00
parent 2f82fb2ceb 46b95318a1
commit a45e38cd8a
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/apm-rest-api.md
View File

@@ -27,6 +27,10 @@ All requests that take parameters require `application/json`.
#### GET /api/packages
Parameters:
- **page** (optional)
Returns a list of all packages in the following format:
```json
[
@@ -44,6 +48,15 @@ Returns a list of all packages in the following format:
]
```
Results are paginated 30 at a time, and links to the next and last pages are
provided in the `Link` header:
```
Link: <https://www.atom.io/api/packages?page=1>; rel="self",
<https://www.atom.io/api/packages?page=41>; rel="last",
<https://www.atom.io/api/packages?page=2>; rel="next"
```
### Showing package details
#### GET /api/packages/:package_name