modio/modio-sdk-legacy

Cursor not present in the documentation

Turupawn opened this issue · 2 comments

  • The Meta Cursor object is missing from the Browse endpoints Response Examples (i.e. Browse Games, Browse Mods)
    Example:
    "meta":{"cursor":{"current":null,"prev":null,"next":31346,"count":11}}

  • The Meta Cursor object it's not explained on the documentation, I think the Filtering section is a good place to do it

  • The cursor and offset params are missing from the Filtering documentation

  • Issue #1 (object not showing in browse endpoint response examples) has been fixed.
  • Issue #2 (meta cursor object not explained in doc), I believe it is? https://docs.mod.io/#cursors-and-offsets
  • Issue #3 (see #2, it is mentioned right above the filtering section), I feel like cursor & offset are maybe more prominent filters that warrant their own section hence not showing under the generic 'Filtering' section. I also don't include _cursor & _offset for each endpoint filter list because it would be repeating it many times, my intention was to mention it at the beginning of the documentation - like the other filtering capabilities so the user is aware these filters are not endpoint-specific but global filters.

Nice!
I agree, cursor and offset should have their own section. Also yeah, adding them to each response example is too repeating.