Skip to content

Improve StructureOfOas.md #689

@kmohr-soprasteria

Description

@kmohr-soprasteria

Currently StructureOfOas looks overloaded and like a wall of text.
I think that restructuring the documentation a bit would greatly help readers to understand everything more easily.

Maybe just have a listing of the headers and provide the descriptions below, e.g.:

path:

parameters
method

operationId
summary
tags
...

responses

...

and then the descriptions below in separated blocks (an own block for parameters, method and its subparts, etc.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions