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

Update REST JS places documentation to reflect pagination changes #1117

Closed
sherylgiovanni opened this issue Aug 16, 2023 · 1 comment
Closed
Assignees
Labels

Comments

@sherylgiovanni
Copy link
Contributor

sherylgiovanni commented Aug 16, 2023

Description

There has been a couple of changes to the places-service relating to pagination which need updating in the REST JS documentation.

Theses pagination changes are:

  • Removed property maxResultsExceeded
  • Renamed links object to pagination
  • Renamed next and previous to nextUrl and previousUrl
  • nextUrl and previousUrl are now full Urls rather than Url fragments - links.base removed

Old format

{
  "results": [/*snip*/],
  "maxResultsExceeded": true,
  "links": {
    "base": "https://places-api.arcgis.com",
    "previous": "/arcgis/rest/services/places-service/v1/places/near-point?x=-3.18718337&y=55.95203695&radius=1000.00000000&searchText=&f=pjson&offset=0&pageSize=10",
    "next": "/arcgis/rest/services/places-service/v1/places/near-point?x=-3.18718337&y=55.95203695&radius=1000.00000000&searchText=&f=pjson&offset=20&pageSize=10"
  }
}

New format:

{
  "results": [/*snip*/],
  "pagination": {
    "previousUrl": "https://placesdev-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?x=-3.18718337&y=55.95203695&radius=1000.00000000&searchText=&f=pjson&offset=0&pageSize=10",
    "nextUrl": "https://placesdev-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?x=-3.18718337&y=55.95203695&radius=1000.00000000&searchText=&f=pjson&offset=20&pageSize=10"
  }
}

Changes needed

These are the pages that still have the old attributes links and maxResultsExceeded and they need to be updated accordingly:

Link to page

https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-places/

@cyatteau cyatteau added good first issue Good for newcomers and beginners and removed good first issue Good for newcomers and beginners labels Sep 26, 2023
@hhkaos hhkaos added good first issue Good for newcomers and beginners docs labels Sep 28, 2023
@patrickarlt patrickarlt removed the good first issue Good for newcomers and beginners label Oct 6, 2023
@gavinr-maps
Copy link
Contributor

fixed in #1133. thanks @sherylgiovanni!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants