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

API docs: $skiptoken and Dataset name conflict #1137

Merged
merged 3 commits into from
May 7, 2024
Merged

API docs: $skiptoken and Dataset name conflict #1137

merged 3 commits into from
May 7, 2024

Conversation

ktuite
Copy link
Member

@ktuite ktuite commented May 3, 2024

Closes getodk/central#580

$skiptoken was introduced in 2023.4 but not mentioned in the API docs, probably because there isn't much to say about it. It is part of the @odata.nextLink, which was already mentioned.

There might be more to add, though:

  • $skip and $skiptoken can't be used together
  • $skiptoken and $order can't be used together
  • If you use $skip originally, you'll get a $skiptoken in the nextLink

I also added the note about Dataset name capitalization conflicts (e.g. "trees" vs. "Trees") and added a 409 conflict response, though I actually chose the response for the direct dataset name conflict.

What has been done to verify that this works as intended?

Why is this the best possible solution? Were any other approaches considered?

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.

Before submitting this PR, please make sure you have:

  • run make test and confirmed all checks still pass OR confirm CircleCI build passes
  • verified that any code from external sources are properly credited in comments or that everything is internally sourced

@ktuite ktuite requested a review from matthew-white May 3, 2024 20:38
@matthew-white
Copy link
Member

There might be more to add, though:

  • $skip and $skiptoken can't be used together
  • $skiptoken and $order can't be used together
  • If you use $skip originally, you'll get a $skiptoken in the nextLink

I agree that it's not particularly useful to mention these things.

docs/api.yaml Outdated Show resolved Hide resolved
docs/api.yaml Outdated Show resolved Hide resolved
@ktuite ktuite merged commit 21582a0 into master May 7, 2024
5 checks passed
@ktuite ktuite deleted the ktuite/docs branch May 7, 2024 01:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add API docs for skip tokens
2 participants