Skip to content

Feature Request: API Documentation : Request with Params-List #3395

@Telaran

Description

@Telaran

Hello together, maybe it's a possible duplicate on #3346 but I'd like to clarify my feature request.

Story

We have some requests (like search/filter) which can have several params and many of them are optional.
paramsdocs_ex001

Requirement

In some cases it's good enough if some of our frontend developer would have access to the "API Documentation" and in that view a "good" params view is missing.
Sure we could (thanks to the markdown feature) add all these in the description of the request but that would be double work and high risk of mistakes.

Current

Currently everything about params are missing.
paramsdocs_ex002

Possible approach

It should contain something like a Table or List (maybe collapsible).
paramsdocs_ex003 (Not styled Table Example, not collapsible)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions