[Feature] Add Schemas to API #2216
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📃 Description
This PR adds comprehensive OpenAPI Schema definitions for our API endpoints, to enrich the generated
openapi.jsonused for documentation.📖 Documentation
I will update the public docs after this merges, so the new
openapi.json(with all the added schemas) can be loaded and published.🪵 Changelog
➕ Added
ForbiddenError,NotFoundError,UnauthenticatedError, andValidationErrorfor all the errors.ServersCollectionSchemafor server listResultsCollectionSchemareferencing the existingResultschema, with inline paginationlinksandmetaQueuedResultResponseSchemarepresenting a queued test payload and its messageSpeedtestResultSchemafor the full speedtest result structure (all nested objects inlined)OpenApiDefinitionFor all the DefinitionsoperationId📷 Screenshots
No UI changes in this PR.