Skip to content

Add OpenAPI Specification (YAML/JSON) #501

@TheDataDexter

Description

@TheDataDexter

Description of your request
Currently, there is no machine-readable OpenAPI specification. This makes it harder for integrators to understand available endpoints and underlying models.

Describe the solution you'd like
Add an official OpenAPI 3.x specification for the hrotusfox-web API, published as either:

  • openapi.yml or
  • openapi.json

The solution should be kept in sync with the API implementation and future modifications/additions

Describe alternatives you've considered
Relying on README and examples
Reverse-engineering the API via network inspection

Additional context

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestimprovementImprove an existing feature

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions