Patch a single OAS API by ID
PATCH {{baseUrl}}/tyk/apis/oas/:apiID?upstreamURL=<string>&listenPath=<string>&customDomain=<string>&validateRequest=true&allowList=true&mockResponse=true&authentication=true
Update API with OAS format. You can use this endpoint to update OAS part of the tyk API definition. This endpoint allows you to configure tyk OAS extension based on query params provided(similar to import)
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
upstreamURL | string | Upstream URL for the API | |
listenPath | string | Listen path for the API | |
customDomain | string | Custom domain for the API | |
validateRequest | boolean | Enable validateRequest middleware for all endpoints having a request body with media type application/json | |
allowList | boolean | Enable allowList middleware for all endpoints | |
mockResponse | boolean | Enable mockResponse middleware for all endpoints having responses configured. | |
authentication | boolean | Enable or disable authentication in your Tyk Gateway as per your OAS document. |
Request Body
{"value"=>"reference https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json not found in the OpenAPI spec"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"action":"\u003cstring\u003e","key":"\u003cstring\u003e","key_hash":"\u003cstring\u003e","status":"\u003cstring\u003e"}