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

Add Query Return Parameters to the Specification #13

Open
dshanske opened this issue Apr 2, 2023 · 3 comments
Open

Add Query Return Parameters to the Specification #13

dshanske opened this issue Apr 2, 2023 · 3 comments

Comments

@dshanske
Copy link
Member

dshanske commented Apr 2, 2023

This proposal is to specifically amend the specification to include the following extensions related to any query made to the Micropub endpoint. Being as these touch multiple extensions, standardizing these would be preferable within the spec.

  1. Filter returned list of items with limit parameter micropub-extensions#35 - A limit parameter added to any query would limit the number of responses.
  2. Support Offset parameter for any query that returns a list of items micropub-extensions#36 - An offset parameter paired with the limit parameter would offset the return by the numerical value the offset is set to
  3. Pagination in Queries micropub-extensions#48 - Adopt the pagination system used in the Microsub spec - https://indieweb.org/Microsub-spec#Paging
  4. Filter Query Parameter to Filter Any Query micropub-extensions#34 - Filter parameter to assist in autocomplete matching using a string.

This would create a universal way to interact with any query, whether built into the spec or not. While many queries do not belong in the spec, but as extensions, I think these concepts would be better served by amending the specification.

@manton
Copy link

manton commented Apr 2, 2023

I think it's a good idea to add a general pagination section to the spec. However, I think the 1 and 2 above conflict with 3. I've been adding support for limit and offset but not the before/after-style pagination from Microsub.

@dshanske
Copy link
Member Author

dshanske commented Apr 2, 2023

That's the point of the discussion. I don't think they conflict because they represent different pagination options

@manton
Copy link

manton commented Apr 2, 2023

To be clear, by "conflict" I just mean they are different ways to solve essentially the same thing. I think it would be confusing to recommend that both solutions are used. I don't have strong opinions about it except that I've already implemented limit/offset. It is kind of a bummer that it's not consistent with Microsub, but I think that's probably okay.

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