Skip to content
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

Fix for File.List endpoint's meta. #26

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion resources/file.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,12 @@ status 200 OK
{
"meta": {
"status": 200,
"record_count": 16
"record_count": 65,
"page_count": 3,
"next_page": "http://platform.api.onesky.io/1/projects/:project_id/files?per_page=25&page=3",
"prev_page": "http://platform.api.onesky.io/1/projects/:project_id/files?per_page=25&page=1",
"first_page": "http://platform.api.onesky.io/1/projects/:project_id/files?per_page=25&page=1",
"last_page": "http://platform.api.onesky.io/1/projects/:project_id/files?per_page=25&page=3"
},
"data": [
{
Expand Down Expand Up @@ -81,6 +86,8 @@ status 200 OK
Remark:
- `status` can be either `completed`, `in-progress` or `failed`.
- Manual input strings will display as a separate file with no `last_import`, `uploaded_at` and `uploaded_at_timestamp`.
- Assume `page = 2` and `per_page = 25`.
- Note that `next_page`, `prev_page`, `first_page` and `last_page` can be `null`.

[Back to top](#file)

Expand Down
10 changes: 9 additions & 1 deletion resources/import_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,13 @@ Required. Details described [here](/README.md#authentication)
``` json
{
"meta": {
"status": 200
"status": 200,
"record_count": 65,
"page_count": 3,
"next_page": "http://platform.api.onesky.io/1/projects/:project_id/import-tasks?per_page=25&page=3",
"prev_page": "http://platform.api.onesky.io/1/projects/:project_id/import-tasks?per_page=25&page=1",
"first_page": "http://platform.api.onesky.io/1/projects/:project_id/import-tasks?per_page=25&page=1",
"last_page": "http://platform.api.onesky.io/1/projects/:project_id/import-tasks?per_page=25&page=3"
},
"data": [
{
Expand All @@ -84,6 +90,8 @@ Required. Details described [here](/README.md#authentication)
Remark:
- `status` can be either `completed`, `in-progress` or `failed`.
- Response may vary according to the way used to import strings. More response sample [here](/reference/import_tasks_response_samples.md#list---list-import-tasks).
- Assume `page = 2` and `per_page = 25`.
- Note that `next_page`, `prev_page`, `first_page` and `last_page` can be `null`.

[Back to top](#import-task)

Expand Down