Matrix parameter support

Redocly / redoc

📘 OpenAPI/Swagger-generated API Reference Documentation

https://redocly.github.io/redoc/

MIT License

23.54k stars 2.3k forks source link

Open marbon opened 5 years ago

marbon commented 5 years ago

Since v2 matrix parameters (https://www.w3.org/DesignIssues/MatrixURIs.html) are part of the OpenAPI Spec. We use them in our API and would be happy about a Redoc support.

parameters:
  - name: id
    in: path
    required: true
    style: matrix
    schema:
      type: string

RomanHotsiy commented 5 years ago

How do you envision it to be rendered?

I have some ideas but wonder what you think.

Thanks!

marbon commented 5 years ago

Sorry I don't have a really smart idea for it. In our case we have paths like this:

api/application-monitoring/applications;id=6097d596c3d9024034b3/services;id=d03b2b5c43acea65e5a4/endpoints

I think at the end you must see the path with his required or optional params

MATRIX PARAMETERS
/applications  
- id = description

/service
-id = description

I'm really looking forward to what you'll come up with. :)

Thank you for your effort.