Skip to content

Conversation

@svenvg93
Copy link
Contributor

@svenvg93 svenvg93 commented May 22, 2025

📃 Description

This PR adds comprehensive OpenAPI Schema definitions for our API endpoints, to enrich the generated openapi.json used 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, and ValidationError for all the errors.
  • ServersCollectionSchema for server list
  • ResultsCollectionSchema referencing the existing Result schema, with inline pagination links and meta
  • QueuedResultResponseSchema representing a queued test payload and its message
  • SpeedtestResultSchema for the full speedtest result structure (all nested objects inlined)
  • OpenApiDefinition For all the Definitions
  • Groups the Endpoints with tags.
  • Add the operationId

📷 Screenshots

No UI changes in this PR.

@svenvg93 svenvg93 requested a review from alexjustesen as a code owner May 22, 2025 15:22
@alexjustesen alexjustesen merged commit 4740bfa into alexjustesen:main May 22, 2025
2 checks passed
@svenvg93 svenvg93 deleted the chore-update-openapi-specs branch May 22, 2025 17:58
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

Successfully merging this pull request may close these issues.

2 participants