Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] arrays in openapi.yaml aren’t rendered as arrays in the generated API docs pages #4848

Open
cwcowell opened this issue Oct 10, 2024 · 0 comments
Assignees

Comments

@cwcowell
Copy link
Contributor

Describe the bug

When you specify a query parameter as taking an array of ints in openapi.yaml, the rendered API docs page indicates that it takes a single int.

To reproduce

STEP 1: Generate docs based on this openapi.yaml:

openapi: 3.0.0
info:
  title: Dummy API
  version: 1.0.0
paths:
  /v2/conversations:
    delete:
      operationId: deleteConversations
      parameters:
        - name: ids
          in: query
          required: true
          style: form
          explode: false
          schema:
            type: array
            items:
              type: integer
      responses:
        '204':
          description: Conversations deleted successfully.

STEP 2: Look at the rendered docs page for that path. It shows the ids parameter as taking a single integer instead of an array of integers.

Expected behavior

The rendered docs page should indicate that the ids parameter takes an array of integers.

Screenshots

image

CLI Version

0.44.11

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants