Skip to content

API doc: parameters and requirements #9

Open
@deniak

Description

@deniak

requirements should be use to list the restrictions on the parameters. If there's a path parameter like api/reports/{report}, {report} should be listed in the parameters.

It brings another problem which is how to differentiate path params and query params such as embed. In swagger, it's possible using the ’in’ property but our bundle doesn't implement it.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions