swagger-editor icon indicating copy to clipboard operation
swagger-editor copied to clipboard

Open API 3.0 and Path Objects

Open lurumad opened this issue 6 years ago • 2 comments

Hi,

We have one question related with Open API 3 and Path Objects in Swagger Editor, if I read https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#pathsObject

The following paths are considered identical and invalid:

/pets/{petId}
/pets/{name}

I don't understand why if I use https://editor.swagger.io seems this is allow me

openapi

openapi: "3.0.0"
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
servers:
  - url: http://petstore.swagger.io/v1
paths:
  /pets:
    get:
      summary: List all pets
      operationId: listPets
      tags:
        - pets
      parameters:
        - name: limit
          in: query
          description: How many items to return at one time (max 100)
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: A paged array of pets
          headers:
            x-next:
              description: A link to the next page of responses
              schema:
                type: string
          content:
            application/json:    
              schema:
                $ref: "#/components/schemas/Pets"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      summary: Create a pet
      operationId: createPets
      tags:
        - pets
      responses:
        '201':
          description: Null response
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /pets/{petId}:
    get:
      summary: Info for a specific pet
      operationId: showPetById
      tags:
        - pets
      parameters:
        - name: petId
          in: path
          required: true
          description: The id of the pet to retrieve
          schema:
            type: string
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pets"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /pets/{name}:
    get:
      summary: Info for a specific pet
      operationId: showPetById
      tags:
        - pets
      parameters:
        - name: name
          in: path
          required: true
          description: The name of the pet to retrieve
          schema:
            type: string
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pets"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
components:
  schemas:
    Pet:
      required:
        - id
        - name
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
          type: string
    Pets:
      type: array
      items:
        $ref: "#/components/schemas/Pet"
    Error:
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string

It's a bug? Because the same in 2.0 is not allowed https://github.com/swagger-api/swagger-editor/issues/1677

Regards!

lurumad avatar Jun 25 '18 12:06 lurumad

Hi @lurumad! You're right, this is not allowed, we just haven't added a validator for this yet 😄

shockey avatar Jul 09 '18 20:07 shockey

image

There is now a lovely validator for this and I think this issue can be closed?

TheTedAdams avatar Jun 06 '22 20:06 TheTedAdams