docusaurus-openapi icon indicating copy to clipboard operation
docusaurus-openapi copied to clipboard

No way to set url parameters

Open xgp opened this issue 3 years ago • 1 comments

I can't find a way to use the generated UI to set url parameters.

For example, I have a path with parameters, and method specified in my openapi spec file like this:

  /{realm}/orgs/{orgId}:
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: orgId
        description: organization id
        required: true
        schema:
          type: string
        style: simple
    put:
      tags:
        - Organizations
      summary: Update this organization by id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationRepresentation'
        required: true
      responses:
        204:
          description: success

It renders the following page: https://phasetwo.io/api/update-this-organization-by-id

But there is no way to set the realm and orgId parameters so that I can execute it from the page.

Am I specifying something incorrectly? Am I missing some configuration option?

Thanks for the help.

xgp avatar Apr 28 '22 17:04 xgp

This looks like a bug on our end. I think we expect “parameters” to be inside the “put” object, but we should support both places

bourdakos1 avatar Apr 28 '22 18:04 bourdakos1