swagger-api / swagger-api/swagger-editor

bug: `deepObject` is not allowed

Open
#5,739 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
9.5k
Forks
2.4k
Avg merge
17h 15m
Merged PRs (30d)
18

Description

Using the following spec causes a lint error. According to the documentation here, deepObject should be allowed in query parameters.

style must be one of allowed values: form, simpleapilint(5150800)
openapi: 3.0.3
info:
  title: Filter API Demo
  version: 1.0.0

paths:
  /users:
    get:
      summary: List users with filter
      parameters:
        - name: filter
          in: query
          style: deepObject
          explode: true
          schema:
            type: object
            properties:
              name:
                type: string
              age:
                type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        age:
                          type: integer
Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the lint error in Swagger Editor with the OpenAPI document shown in the issue, then trace validation of query-parameter styles. The work is done when a query parameter using style deepObject is accepted without the reported lint error and existing validation still passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.