petstore.yaml

openapi: 3.0.0
x-proto-package: petstore
x-proto-service: PetstoreService
x-proto-import:
  - "github.com/gogo/protobuf/gogoproto/gogo.proto"
x-proto-option:
  "gogoproto.goproto_registration": true
  "gogoproto.messagename_all": true
  "php_generic_services": true
servers:
  - description: SwaggerHub API Auto Mocking
    url: https://virtserver.swaggerhub.com/LorenzHW/originalPetstore/1.0.0
info:
  description: |
    This is a sample Petstore server.  You can find
    out more about Swagger at
    [http://swagger.io](http://swagger.io) or on
    [irc.freenode.net, #swagger](http://swagger.io/irc/).
  version: "1.0.0"
  title: Swagger Petstore
  termsOfService: 'http://swagger.io/terms/'
  contact:
    email: apiteam@swagger.io
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
  - name: pet
    description: Everything about your Pets
    externalDocs:
      description: Find out more
      url: 'http://swagger.io'
  - name: store
    description: Access to Petstore orders
  - name: user
    description: Operations about user
    externalDocs:
      description: Find out more about our store
      url: 'http://swagger.io'
paths:
  /pet:
    post:
      tags:
        - pet
      summary: Add a new pet to the store
      operationId: addPet
      x-proto-request: AddPetRequestCustom
      x-proto-response: AddPetResponseCustom
      responses:
        '405':
          description: Invalid input
      #      security:
      #        - petstore_auth:
      #            - 'write:pets'
      #            - 'read:pets'
      requestBody:
        #        $ref: '#/components/requestBodies/Pet'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Pet'
    put:
      tags:
        - pet
      summary: Update an existing pet
      operationId: updatePet
      responses:
        '400':
          description: Invalid ID supplied
        '404':
          description: Pet not found
        '405':
          description: Validation exception
      #      security:
      #        - petstore_auth:
      #            - 'write:pets'
      #            - 'read:pets'
      parameters:
        - name: tags
          in: query
          description: Tags to filter by
          required: true
          explode: true
          schema:
            type: array
            items:
              type: string
      requestBody:
        #        $ref: '#/components/requestBodies/Pet'
        content:
          application/json:
            x-proto-field: pet
            schema:
              $ref: '#/components/schemas/Pet'
  /pet/findByStatus:
    get:
      tags:
        - pet
      summary: Finds Pets by status
      description: Multiple status values can be provided with comma separated strings
      operationId: findPetsByStatus
      parameters:
        - name: status
          in: query
          description: Status values that need to be considered for filter
          required: true
          explode: true
          schema:
            type: array
            items:
              $ref: '#/components/schemas/PetStatus'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              x-proto-field: pets
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Pet'
        #            application/xml:
        #              schema:
        #                type: array
        #                items:
        #                  $ref: '#/components/schemas/Pet'
        '400':
          description: Invalid status value
  #      security:
  #        - petstore_auth:
  #            - 'write:pets'
  #            - 'read:pets'
  /pet/findByTags:
    get:
      tags:
        - pet
      summary: Finds Pets by tags
      description: >-
        Multiple tags can be provided with comma separated strings. Use\ \ tag1,
        tag2, tag3 for testing.
      operationId: findPetsByTags
      parameters:
        - name: tags
          in: query
          description: Tags to filter by
          required: true
          explode: true
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              x-proto-field: pets
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Pet'
        #            application/xml:
        #              schema:
        #                type: array
        #                items:
        #                  $ref: '#/components/schemas/Pet'
        '400':
          description: Invalid tag value
      #      security:
      #        - petstore_auth:
      #            - 'write:pets'
      #            - 'read:pets'
      deprecated: true
  '/pet/{petId}':
    get:
      tags:
        - pet
      summary: Find pet by ID
      description: Returns a single pet
      operationId: getPetById
      parameters:
        - name: petId
          in: path
          description: ID of pet to return
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              x-proto-field: pet
              schema:
                $ref: '#/components/schemas/Pet'
        #            application/xml:
        #              schema:
        #                $ref: '#/components/schemas/Pet'
        '400':
          description: Invalid ID supplied
        '404':
          description: Pet not found
    #      security:
    #        - api_key: []
    #    post:
    #      tags:
    #        - pet
    #      summary: Updates a pet in the store with form data
    #      operationId: updatePetWithForm
    #      parameters:
    #        - name: petId
    #          in: path
    #          description: ID of pet that needs to be updated
    #          required: true
    #          schema:
    #            type: integer
    #            format: int64
    #      responses:
    #        '405':
    #          description: Invalid input
    #      security:
    #        - petstore_auth:
    #            - 'write:pets'
    #            - 'read:pets'
    #      requestBody:
    #        content:
    #          application/x-www-form-urlencoded:
    #            schema:
    #              type: object
    #              properties:
    #                name:
    #                  description: Updated name of the pet
    #                  type: string
    #                status:
    #                  description: Updated status of the pet
    #                  type: string
    delete:
      tags:
        - pet
      summary: Deletes a pet
      operationId: deletePet
      parameters:
        - name: api_key
          in: header
          required: false
          schema:
            type: string
        - name: petId
          in: path
          description: Pet id to delete
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '400':
          description: Invalid ID supplied
        '404':
          description: Pet not found
  #      security:
  #        - petstore_auth:
  #            - 'write:pets'
  #            - 'read:pets'
  '/pet/{petId}/uploadImage':
    post:
      tags:
        - pet
      summary: uploads an image
      operationId: uploadFile
      parameters:
        - name: petId
          in: path
          description: ID of pet to update
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              x-proto-field: response
              schema:
                $ref: '#/components/schemas/ApiResponse'
      #      security:
      #        - petstore_auth:
      #            - 'write:pets'
      #            - 'read:pets'
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
  #  /store/inventory:
  #    get:
  #      tags:
  #        - store
  #      summary: Returns pet inventories by status
  #      description: Returns a map of status codes to quantities
  #      operationId: getInventory
  #      responses:
  #        '200':
  #          description: successful operation
  #          content:
  #            application/json:
  #              schema:
  #                type: object
  #                additionalProperties:
  #                  type: integer
  #                  format: int32
  #      security:
  #        - api_key: []
  /store/order:
    post:
      tags:
        - store
      summary: Place an order for a pet
      operationId: placeOrder
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              x-proto-field: order
              schema:
                $ref: '#/components/schemas/Order'
        #            application/xml:
        #              schema:
        #                $ref: '#/components/schemas/Order'
        '400':
          description: Invalid Order
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Order'
        description: order placed for purchasing the pet
        required: true
  '/store/order/{orderId}':
    get:
      tags:
        - store
      summary: Find purchase order by ID
      description: >-
        For valid response try integer IDs with value >= 1 and <= 10.\ \ Other
        values will generated exceptions
      operationId: getOrderById
      parameters:
        - name: orderId
          in: path
          description: ID of pet that needs to be fetched
          required: true
          schema:
            type: integer
            format: int64
            minimum: 1
            maximum: 10
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              x-proto-field: order
              schema:
                $ref: '#/components/schemas/Order'
        #            application/xml:
        #              schema:
        #                $ref: '#/components/schemas/Order'
        '400':
          description: Invalid ID supplied
        '404':
          description: Order not found
    delete:
      tags:
        - store
      summary: Delete purchase order by ID
      description: >-
        For valid response try integer IDs with positive integer value.\ \
        Negative or non-integer values will generate API errors
      operationId: deleteOrder
      parameters:
        - name: orderId
          in: path
          description: ID of the order that needs to be deleted
          required: true
          schema:
            type: integer
            format: int64
            minimum: 1
      responses:
        '400':
          description: Invalid ID supplied
        '404':
          description: Order not found
  /user:
    post:
      tags:
        - user
      summary: Create user
      description: This can only be done by the logged in user.
      operationId: createUser
      responses:
        default:
          description: successful operation
      requestBody:
        content:
          application/json:
            x-proto-field: user
            schema:
              $ref: '#/components/schemas/User'
        description: Created user object
        required: true
  /user/createWithArray:
    post:
      tags:
        - user
      summary: Creates list of users with given input array
      operationId: createUsersWithArrayInput
      responses:
        default:
          description: successful operation
      requestBody:
        #        $ref: '#/components/requestBodies/UserArray'
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/User'
  /user/createWithList:
    post:
      tags:
        - user
      summary: Creates list of users with given input array
      operationId: createUsersWithListInput
      responses:
        default:
          description: successful operation
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/User'
  /user/login:
    get:
      tags:
        - user
      summary: Logs user into the system
      operationId: loginUser
      parameters:
        - name: username
          in: query
          description: The user name for login
          required: true
          schema:
            type: string
        - name: password
          in: query
          description: The password for login in clear text
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          #          headers:
          #            X-Rate-Limit:
          #              description: calls per hour allowed by the user
          #              schema:
          #                type: integer
          #                format: int32
          #            X-Expires-After:
          #              description: date in UTC when token expires
          #              schema:
          #                type: string
          #                format: date-time
          content:
            text/plain:
              x-proto-field: info
              schema:
                type: string
        #            application/json:
        #              schema:
        #                type: string
        #            application/xml:
        #              schema:
        #                type: string
        '400':
          description: Invalid username/password supplied
  /user/logout:
    get:
      tags:
        - user
      summary: Logs out current logged in user session
      operationId: logoutUser
      responses:
        default:
          description: successful operation
  '/user/{username}':
    get:
      tags:
        - user
      summary: Get user by user name
      operationId: getUserByName
      parameters:
        - name: username
          in: path
          description: The name that needs to be fetched. Use user1 for testing.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              x-proto-field: user
              schema:
                $ref: '#/components/schemas/User'
        #            application/xml:
        #              schema:
        #                $ref: '#/components/schemas/User'
        '400':
          description: Invalid username supplied
        '404':
          description: User not found
    put:
      tags:
        - user
      summary: Updated user
      description: This can only be done by the logged in user.
      operationId: updateUser
      parameters:
        - name: username
          in: path
          description: name that need to be updated
          required: true
          schema:
            type: string
      responses:
        '400':
          description: Invalid user supplied
        '404':
          description: User not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
        description: Updated user object
        required: true
    delete:
      tags:
        - user
      summary: Delete user
      description: This can only be done by the logged in user.
      operationId: deleteUser
      parameters:
        - name: username
          in: path
          description: The name that needs to be deleted
          required: true
          schema:
            $ref: "#/components/schemas/VerificationType"
      responses:
        '400':
          description: Invalid username supplied
        '404':
          description: User not found
externalDocs:
  description: Find out more about Swagger
  url: 'http://swagger.io'
components:
  schemas:
    TestMessage:
      type: object
      properties:
        test1:
          x-proto-field: test2
          oneOf:
            - $ref: '#/components/schemas/PetStatus'
            - $ref: '#/components/schemas/Pet'
            - $ref: '#/components/schemas/OrderStatus'
            - $ref: '#/components/schemas/Category'
        testOption:
          type: integer
          format: int32
          x-proto-option:
            "gogoproto.moretags": 'sensitive:"true"'
        testOption2:
          type: integer
          format: int32
          x-proto-option:
            "gogoproto.moretags": 'sensitive:"true"'
            "gogoproto.casttype": 'sensitive:"true"'
        testIntegers:
          oneOf:
            - type: integer
              format: int32
              x-proto-field: test_v32
              x-proto-format: varint
            - type: integer
              format: int32
              x-proto-field: test_f32
              x-proto-format: fixed
            - type: integer
              format: int64
              x-proto-field: test_v64
              x-proto-format: varint
            - type: integer
              format: int64
              x-proto-field: test_f64
              x-proto-format: fixed
        testDates:
          oneOf:
            - type: string
              format: date-time
              x-proto-field: unix_seconds
              x-proto-format: unix-time
              description: in seconds
            - type: string
              format: date-time
              x-proto-field: unix_millis
              x-proto-format: unix-time-millis
              description: in millis
            - type: string
              format: date-time
              x-proto-field: proto_timestamp
              x-proto-format: timestamp
              description: using protobuf built-in timestamp
    VerificationType:
      type: string
      enum:
        - none
        - email
    PetStatus:
      type: string
      x-proto-wrapper: PetStatusWrapper
      enum:
        - available
        - pending
        - sold
      default: available
    OrderStatus:
      type: string
      enum:
        - placed
        - approved
        - delivered
    OrderID:
      type: integer
      format: int64
      description: Номер документа
    Order:
      type: object
      x-proto-reserved:
        - 1
        - 2
        - 5
      properties:
        id:
          x-proto-field-id: 4
          $ref: '#/components/schemas/OrderID'
        petId:
          type: integer
          format: int64
        quantity:
          type: integer
          format: int32
        shipDate:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/OrderStatus'
        complete:
          type: boolean
          default: false
      xml:
        name: Order
    Category:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      xml:
        name: Category
    User:
      type: object
      properties:
        id:
          type: integer
          format: int64
        username:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        password:
          type: string
        phone:
          type: string
        userStatus:
          type: integer
          format: int32
          description: User Status
      xml:
        name: User
    Tag:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      xml:
        name: Tag
    Pet:
      type: object
      required:
        - name
        - photoUrls
      properties:
        id:
          type: integer
          format: int64
        category:
          $ref: '#/components/schemas/Category'
        name:
          type: string
          example: doggie
        photoUrls:
          type: array
          xml:
            name: photoUrl
            wrapped: true
          items:
            type: string
        tags:
          type: array
          xml:
            name: tag
            wrapped: true
          items:
            $ref: '#/components/schemas/Tag'
        status:
          $ref: '#/components/schemas/PetStatus'
      xml:
        name: Pet
    ApiResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        type:
          type: string
        message:
          type: string
#  requestBodies:
#    Pet:
#      content:
#        application/json:
#          schema:
#            $ref: '#/components/schemas/Pet'
#        application/xml:
#          schema:
#            $ref: '#/components/schemas/Pet'
#      description: Pet object that needs to be added to the store
#      required: true
#    UserArray:
#      content:
#        application/json:
#          schema:
#            type: array
#            items:
#              $ref: '#/components/schemas/User'
#      description: List of user object
#      required: true
#  securitySchemes:
#    petstore_auth:
#      type: oauth2
#      flows:
#        implicit:
#          authorizationUrl: 'http://petstore.swagger.io/oauth/dialog'
#          scopes:
#            'write:pets': modify pets in your account
#            'read:pets': read your pets
#    api_key:
#      type: apiKey
#      name: api_key
#      in: header