Created
January 12, 2022 16:53
-
-
Save lpar/4af360f8a2c94d2a31c6e12062f2812c to your computer and use it in GitHub Desktop.
Modified petstore.yaml to demonstrate openapi-generator bug
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: 3.0.0 | |
| servers: | |
| - url: 'http://petstore.swagger.io/v2' | |
| info: | |
| description: >- | |
| This is a sample server Petstore server. For this sample, you can use the api key | |
| `special-key` to test the authorization filters. | |
| version: 1.0.0 | |
| title: OpenAPI Petstore | |
| license: | |
| name: Apache-2.0 | |
| url: 'https://www.apache.org/licenses/LICENSE-2.0.html' | |
| tags: | |
| - name: pet | |
| description: Everything about your Pets | |
| - name: store | |
| description: Access to Petstore orders | |
| - name: user | |
| description: Operations about user | |
| paths: | |
| /pet: | |
| post: | |
| tags: | |
| - pet | |
| summary: Add a new pet to the store | |
| description: '' | |
| operationId: addPet | |
| responses: | |
| '200': | |
| description: successful operation | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Pet' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Pet' | |
| '405': | |
| description: Invalid input | |
| security: | |
| - petstore_auth: | |
| - 'write:pets' | |
| - 'read:pets' | |
| requestBody: | |
| $ref: '#/components/requestBodies/Pet' | |
| put: | |
| tags: | |
| - pet | |
| summary: Update an existing pet | |
| description: '' | |
| operationId: updatePet | |
| responses: | |
| '200': | |
| description: successful operation | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Pet' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Pet' | |
| '400': | |
| description: Invalid ID supplied | |
| '404': | |
| description: Pet not found | |
| '405': | |
| description: Validation exception | |
| security: | |
| - petstore_auth: | |
| - 'write:pets' | |
| - 'read:pets' | |
| requestBody: | |
| $ref: '#/components/requestBodies/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 | |
| style: form | |
| explode: false | |
| deprecated: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - available | |
| - pending | |
| - sold | |
| default: available | |
| responses: | |
| '200': | |
| description: successful operation | |
| content: | |
| application/xml: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Pet' | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Pet' | |
| '400': | |
| description: Invalid status value | |
| security: | |
| - petstore_auth: | |
| - '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 | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| responses: | |
| '200': | |
| description: successful operation | |
| content: | |
| application/xml: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Pet' | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Pet' | |
| '400': | |
| description: Invalid tag value | |
| security: | |
| - petstore_auth: | |
| - '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/xml: | |
| schema: | |
| $ref: '#/components/schemas/Pet' | |
| application/json: | |
| 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 | |
| description: '' | |
| 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: | |
| pet-name: | |
| description: Updated name of the pet | |
| type: string | |
| pet-status: | |
| description: Updated status of the pet | |
| type: string | |
| delete: | |
| tags: | |
| - pet | |
| summary: Deletes a pet | |
| description: '' | |
| 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 pet value | |
| security: | |
| - petstore_auth: | |
| - 'write:pets' | |
| - 'read:pets' | |
| '/pet/{petId}/uploadImage': | |
| post: | |
| tags: | |
| - pet | |
| summary: uploads an image | |
| description: '' | |
| 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: | |
| schema: | |
| $ref: '#/components/schemas/ApiResponse' | |
| security: | |
| - petstore_auth: | |
| - 'write:pets' | |
| - 'read:pets' | |
| requestBody: | |
| content: | |
| multipart/form-data: | |
| schema: | |
| type: object | |
| properties: | |
| additionalMetadata: | |
| description: Additional data to pass to server | |
| type: string | |
| file: | |
| description: file to upload | |
| 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 | |
| description: '' | |
| operationId: placeOrder | |
| responses: | |
| '200': | |
| description: successful operation | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Order' | |
| application/json: | |
| 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 <= 5 or > 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: 5 | |
| responses: | |
| '200': | |
| description: successful operation | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Order' | |
| application/json: | |
| 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 value < 1000. Anything above | |
| 1000 or nonintegers 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: string | |
| 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 | |
| security: | |
| - api_key: [] | |
| requestBody: | |
| content: | |
| application/json: | |
| 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 | |
| description: '' | |
| operationId: createUsersWithArrayInput | |
| responses: | |
| default: | |
| description: successful operation | |
| security: | |
| - api_key: [] | |
| requestBody: | |
| $ref: '#/components/requestBodies/UserArray' | |
| /user/createWithList: | |
| post: | |
| tags: | |
| - user | |
| summary: Creates list of users with given input array | |
| description: '' | |
| operationId: createUsersWithListInput | |
| responses: | |
| default: | |
| description: successful operation | |
| security: | |
| - api_key: [] | |
| requestBody: | |
| $ref: '#/components/requestBodies/UserArray' | |
| /user/login: | |
| get: | |
| tags: | |
| - user | |
| summary: Logs user into the system | |
| description: '' | |
| operationId: loginUser | |
| parameters: | |
| - name: username | |
| in: query | |
| description: The user name for login | |
| required: true | |
| schema: | |
| type: string | |
| pattern: '^[a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*[a-zA-Z0-9]+$' | |
| - name: password | |
| in: query | |
| description: The password for login in clear text | |
| required: true | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: successful operation | |
| headers: | |
| Set-Cookie: | |
| description: >- | |
| Cookie authentication key for use with the `api_key` | |
| apiKey authentication. | |
| schema: | |
| type: string | |
| example: AUTH_KEY=abcde12345; Path=/; HttpOnly | |
| 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: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| '400': | |
| description: Invalid username/password supplied | |
| /user/logout: | |
| get: | |
| tags: | |
| - user | |
| summary: Logs out current logged in user session | |
| description: '' | |
| operationId: logoutUser | |
| responses: | |
| default: | |
| description: successful operation | |
| security: | |
| - api_key: [] | |
| '/user/{username}': | |
| get: | |
| tags: | |
| - user | |
| summary: Get user by user name | |
| description: '' | |
| 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/xml: | |
| schema: | |
| $ref: '#/components/schemas/User' | |
| application/json: | |
| 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 deleted | |
| required: true | |
| schema: | |
| type: string | |
| responses: | |
| '400': | |
| description: Invalid user supplied | |
| '404': | |
| description: User not found | |
| security: | |
| - api_key: [] | |
| 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: | |
| type: string | |
| responses: | |
| '400': | |
| description: Invalid username supplied | |
| '404': | |
| description: User not found | |
| security: | |
| - api_key: [] | |
| externalDocs: | |
| description: Find out more about Swagger | |
| url: 'http://swagger.io' | |
| components: | |
| requestBodies: | |
| UserArray: | |
| content: | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/User' | |
| description: List of user object | |
| required: true | |
| 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 | |
| securitySchemes: | |
| petstore_auth: | |
| type: oauth2 | |
| flows: | |
| implicit: | |
| authorizationUrl: 'http://petstore.swagger.io/api/oauth/dialog' | |
| scopes: | |
| 'write:pets': modify pets in your account | |
| 'read:pets': read your pets | |
| api_key: | |
| type: apiKey | |
| name: api_key | |
| in: header | |
| schemas: | |
| Order: | |
| title: Pet Order | |
| description: An order for a pets from the pet store | |
| type: object | |
| properties: | |
| order-id: | |
| type: integer | |
| format: int64 | |
| pet-id: | |
| type: integer | |
| format: int64 | |
| order-quantity: | |
| type: integer | |
| format: int32 | |
| order-ship-date: | |
| type: string | |
| format: date-time | |
| order-status: | |
| type: string | |
| description: Order Status | |
| enum: | |
| - placed | |
| - approved | |
| - delivered | |
| order-complete: | |
| type: boolean | |
| default: false | |
| xml: | |
| name: Order | |
| Category: | |
| title: Pet category | |
| description: A category for a pet | |
| type: object | |
| properties: | |
| category-id: | |
| type: integer | |
| format: int64 | |
| category-name: | |
| type: string | |
| pattern: '^[a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*[a-zA-Z0-9]+$' | |
| xml: | |
| name: Category | |
| User: | |
| title: a User | |
| description: A User who is purchasing from the pet store | |
| type: object | |
| properties: | |
| user-id: | |
| type: integer | |
| format: int64 | |
| user-name: | |
| type: string | |
| user-firstName: | |
| type: string | |
| user-lastName: | |
| type: string | |
| user-email: | |
| type: string | |
| user-password: | |
| type: string | |
| user-phone: | |
| type: string | |
| user-status: | |
| type: integer | |
| format: int32 | |
| description: User Status | |
| xml: | |
| name: User | |
| Tag: | |
| title: Pet Tag | |
| description: A tag for a pet | |
| type: object | |
| properties: | |
| tag-id: | |
| type: integer | |
| format: int64 | |
| tag-name: | |
| type: string | |
| xml: | |
| name: Tag | |
| Pet: | |
| title: a Pet | |
| description: A pet for sale in the pet store | |
| type: object | |
| required: | |
| - name | |
| - photoUrls | |
| properties: | |
| pet-id: | |
| type: integer | |
| format: int64 | |
| pet-category: | |
| $ref: '#/components/schemas/Category' | |
| pet-name: | |
| type: string | |
| example: doggie | |
| photoUrls: | |
| type: array | |
| xml: | |
| name: photoUrl | |
| wrapped: true | |
| items: | |
| type: string | |
| pet-tags: | |
| type: array | |
| xml: | |
| name: tag | |
| wrapped: true | |
| items: | |
| $ref: '#/components/schemas/Tag' | |
| pet-status: | |
| type: string | |
| description: pet status in the store | |
| deprecated: true | |
| enum: | |
| - available | |
| - pending | |
| - sold | |
| xml: | |
| name: Pet | |
| ApiResponse: | |
| title: An uploaded response | |
| description: Describes the result of uploading an image resource | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| format: int32 | |
| type: | |
| type: string | |
| message: | |
| type: string |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment