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

Extended Collection Query Parameters #6

Open
jonathanrobie opened this issue Jan 24, 2019 · 5 comments
Open

Extended Collection Query Parameters #6

jonathanrobie opened this issue Jan 24, 2019 · 5 comments

Comments

@jonathanrobie
Copy link

Interpretation of existing DTS query parameters should be no different for updates than for anything else. Is this section needed?

@monotasker
Copy link
Owner

Good question. I tend to think in terms of a user reading the documentation, and so if it will help the usability of the docs I sometimes lean towards duplication. But that does have a maintainability cost. Maybe what I could do is link to the relevant sections of the core docs instead of duplicating.

@jonathanrobie
Copy link
Author

jonathanrobie commented Feb 6, 2019

I would prefer to have a change proposal that states only what needs to be changed or added. If we accept this proposal, have we changed the query parameters in DTS or not? If we have, exactly how? That's hard to see in this proposal.

I would expect it to specify the PUT, POST, and DELETE methods to be added to particular endpoints.

@monotasker
Copy link
Owner

Alright. I can see your point. But I've put a lot of work into the proposal and I think for the most part it's clear what is new. I would prefer to discuss it as is rather than reworking the whole thing first.

@jonathanrobie
Copy link
Author

jonathanrobie commented Feb 6, 2019

Can I ignore everything except for the PUT, POST, and DELETE methods, assuming nothing else has changed?

If not, can you specify precisely what else has changed, in one place?

@monotasker
Copy link
Owner

I explain this in the text of the Extended URI section for each endpoint. But for Collections the new parameters are "token" and "parent". For Documents the new parameters are "after", "before", and "token". Where I talk about the query attributes for each method I also include a discussion of the existing params, but in some cases their use changes slightly so it's still a good idea to read that. Sorry that I didn't highlight the changes more clearly, but I was thinking in terms of writing user documentation.

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

No branches or pull requests

2 participants