search

indieweb / Micropub

The Micropub spec
https://micropub.net/draft/
7 stars 0 forks source link

Add Query Return Parameters to the Specification #13

Open dshanske opened 1 year ago

dshanske commented 1 year ago

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. https://github.com/indieweb/micropub-extensions/issues/35 - A limit parameter added to any query would limit the number of responses.
  2. https://github.com/indieweb/micropub-extensions/issues/36 - An offset parameter paired with the limit parameter would offset the return by the numerical value the offset is set to
  3. https://github.com/indieweb/micropub-extensions/issues/48 - Adopt the pagination system used in the Microsub spec - https://indieweb.org/Microsub-spec#Paging
  4. https://github.com/indieweb/micropub-extensions/issues/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 commented 1 year ago

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 commented 1 year ago

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

manton commented 1 year ago

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.