Skip to content

Enhance API interface description with OpenAPI/Swagger/xyz format #6

@hb-tpfister

Description

@hb-tpfister

In addition to your existing documentation it would be nice if you could provide the API interface descriptions in a standard format like OpenAPI / Swagger (or if you are using something else internally already, that). Benefits include a quick overview with technical details, possibilities to use client generators (which may need minor adjustments), etc.

This would either be possible via this repository or if you prefer as a living documentation on a new API endpoint of yours.

Thanks for considering!

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions