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

Paging response results and metadata #55

Closed
2 tasks done
fmigneault opened this issue Nov 14, 2019 · 0 comments
Closed
2 tasks done

Paging response results and metadata #55

fmigneault opened this issue Nov 14, 2019 · 0 comments
Assignees
Labels
triage/conformance Issue related to fixing/ensuring compliance to specifications.

Comments

@fmigneault
Copy link
Collaborator

fmigneault commented Nov 14, 2019

Results returned from following routes should support paging and add additional metadata:

  • GET /processes
  • GET /proceses/{id}/jobs

Additional paging metadata should be defined as in follow:

{
    <...>, 
    "links": [
    { "href": "<this_url_path>?page=<page>&limit=<limit>",
      "rel": "self", 
      "type": "application/json", 
      "title": "This page results" },
    { "href": "<this_url_path>?page=0&limit=<limit>",
      "rel": "first", 
      "type": "application/json", 
      "title": "This page results" },
    { "href": "<this_url_path>?page=<page-1>&limit=<limit>",
      "rel": "prev", 
      "type": "application/json", 
      "title": "Previous page results" },
    { "href": "<this_url_path>?page=<page+1>&limit=<limit>",
      "rel": "next", 
      "type": "application/json", 
      "title": "Next page results" },
    { "href": "<this_url_path>?page=<max(page)>&limit=<limit>",
      "rel": "last", 
      "type": "application/json", 
      "title": "Last page results" }
  ]
}

see example:
https://github.com/opengeospatial/oapi_common/blob/master/standard/examples/collections_metadata_JSON_1.adoc

@fmigneault fmigneault added the triage/conformance Issue related to fixing/ensuring compliance to specifications. label Nov 14, 2019
@fmigneault fmigneault self-assigned this Nov 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage/conformance Issue related to fixing/ensuring compliance to specifications.
Projects
None yet
Development

No branches or pull requests

1 participant