Created
February 3, 2021 10:30
-
-
Save RonnyPfannschmidt/71a7d9bc344be968f0fed5559b5ee502 to your computer and use it in GitHub Desktop.
example openapiapi spec for unknown base type issue
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", | |
"info": { | |
"title": "example", | |
"description": "example", | |
"version": "1.2.3", | |
"contact": {} | |
}, | |
"servers": [ | |
{ | |
"url": "/api/example/v1", | |
"description": "relative path" | |
} | |
], | |
"tags": [ | |
{ | |
"name": "example", | |
"description": "example" | |
} | |
], | |
"paths": { | |
"/example/{id}/run": { | |
"post": { | |
"tags": [ | |
"example" | |
], | |
"summary": "Execute example", | |
"description": "Execute example", | |
"operationId": "runExample", | |
"parameters": [ | |
{ | |
"$ref": "#/components/parameters/ExampleId" | |
} | |
], | |
"requestBody": { | |
"$ref": "#/components/requestBodies/ExampleRunsInput" | |
}, | |
"responses": { | |
"201": { | |
"description": "Created", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ExecuteExample" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"components": { | |
"parameters": { | |
"ExampleId": { | |
"in": "path", | |
"name": "remediation", | |
"description": "example identifier (uuid)", | |
"required": true, | |
"schema": { | |
"$ref": "#/components/schemas/ExampleId" | |
} | |
} | |
}, | |
"requestBodies": { | |
"ExampleRunsInput": { | |
"required": false, | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"exclude": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"schemas": { | |
"ExampleId": { | |
"type": "string", | |
"format": "uuid", | |
"example": "9197ba55-0abc-4028-9bbe-269e530f8bd5" | |
}, | |
"ExecuteExample": { | |
"type": "object", | |
"additionalProperties": false, | |
"required": [ | |
"id" | |
], | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/ExampleId" | |
} | |
} | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment