Indicate the the 'observation search' request takes pagination parameters.

[frewsxcv]

Assuming I'm reading the source correctly, this request does honor these parameters:

iNaturalistAPI/openapi/schema/request/observations_search.js

Lines 282 to 296 in 30987c8

	page: Joi.number( ).integer( ),
	per_page: Joi.number( ).integer( ),
	order: Joi.string( ).valid(
	"desc",
	"asc"
	),
	order_by: Joi.string( ).valid(
	"observed_on",
	"updated_at",
	"species_guess",
	"votes",
	"id",
	"created_at",
	"random"
	),

[frewsxcv]

Hmm this might not be this simple, since the 'observation observers' endpoint also has type = search:

iNaturalistAPI/lib/views/swagger_v1.yml.ejs

Lines 995 to 1004 in 30987c8

	/observations/observers:
	get:
	summary: Observation Observers
	description: |
	Given zero to many of following parameters, returns observers of
	observations matching the search criteria and the count of
	observations and distinct taxa of rank `species` they have observed. A
	maximum of 500 results will be returned
	parameters:
	<%- include( "_observation_search_params_v1.yml.ejs", { type: "search" } ) %>

...but has a different set of expected parameters:

iNaturalistAPI/openapi/schema/request/observations_observers.js

Lines 5 to 8 in 30987c8

	order_by: Joi.string( ).valid(
	"observation_count",
	"species_count"
	).default( "observation_count" )

[pleary]

Could you please be more clear about what the problem is that this PR is attempting to fix? The title says Indicate the the 'observation search' request takes pagination parameters, but the documentation for observation search in both API v1 and v2 do include pagination parameters in their swagger documentation, e.g. https://api.inaturalist.org/v1/docs/#!/Observations/get_observations and https://api.inaturalist.org/v2/docs/#/Observations/get_observations.

Specifically what endpoints (including API version) don't document pagination parameters but should?

[frewsxcv]

@pleary If I recall correctly, I ran into this when using the /observations/species_count endpoint, which inherits much of the logic from observation search but doesn't include the pagination parameters

[frewsxcv]

And agreed the way I worded the original issue was not clear, sorry about that!

[pleary]

I pushed a commit fbcb988 where I explicitly add the page and per_page parameters for the species_count endpoint. They are now included in the V1 documentation https://api.inaturalist.org/v1/docs/#!/Observations/get_observations_species_counts . Does that look like it resolves the issue at hand here?

We have several endpoints that share a lot of the same parameters for filtering data, but not some of the more usability oriented parameters like ordering and sorting. OpenAPI/swagger doesn't have a great way of supporting the idea of reusable subsets of parameters, so the implementation here isn't as clean as I'd prefer. Thanks for making the pull request and raising the issue about the undocumented parameters!

[frewsxcv]

Perfect! Thank you so much @pleary 🌻