From f8e3ac55e50ed1053992c1be578e22630f581e7f Mon Sep 17 00:00:00 2001 From: Milosz Marcinkowski Date: Wed, 30 Oct 2024 17:34:25 +0100 Subject: [PATCH] add missing http responses --- .../apm/docs/openapi/apm/bundled.json | 392 +++++++++++++++--- .../apm/docs/openapi/apm/bundled.yaml | 258 ++++++++++-- .../apm/components/schemas/401_response.yaml | 10 + .../apm/components/schemas/403_response.yaml | 10 + .../components/schemas/agent_keys_object.yaml | 3 + .../schemas/agent_keys_response.yaml | 23 +- .../openapi/apm/paths/api@apm@agent_keys.yaml | 18 + .../api@apm@fleet@apm_server_schema.yaml | 12 + ...apm@services@{serviceName}@annotation.yaml | 18 + ...vices@{serviceName}@annotation@search.yaml | 12 + .../api@apm@settings@agent_configuration.yaml | 30 ++ ...ttings@agent_configuration@agent_name.yaml | 6 + ...m@settings@agent_configuration@search.yaml | 6 + ...apm@settings@agent_configuration@view.yaml | 8 +- .../openapi/apm/paths/api@apm@sourcemaps.yaml | 18 + .../apm/paths/api@apm@sourcemaps@{id}.yaml | 12 + ...ings@agent_configuration@environments.yaml | 6 + 17 files changed, 726 insertions(+), 116 deletions(-) create mode 100644 x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/401_response.yaml create mode 100644 x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/403_response.yaml diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.json b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.json index 07af1bdbb9ea5..940979f3ddbbd 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.json +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.json @@ -40,7 +40,7 @@ "$ref": "#/components/parameters/elastic_api_version" }, { - "$ref": "#/components/parameters/kbn-xsrf" + "$ref": "#/components/parameters/kbn_xsrf" } ], "requestBody": { @@ -73,6 +73,36 @@ } } } + }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, + "403": { + "description": "Forbidden response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/403_response" + } + } + } + }, + "500": { + "description": "Internal Server Error response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500_response" + } + } + } } } } @@ -146,6 +176,26 @@ } } } + }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, + "500": { + "description": "Internal Server Error response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/500_response" + } + } + } } } } @@ -163,7 +213,7 @@ "$ref": "#/components/parameters/elastic_api_version" }, { - "$ref": "#/components/parameters/kbn-xsrf" + "$ref": "#/components/parameters/kbn_xsrf" }, { "name": "serviceName", @@ -205,6 +255,36 @@ } } } + }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, + "403": { + "description": "Forbidden response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/403_response" + } + } + } + }, + "404": { + "description": "Not found response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404_response" + } + } + } } } } @@ -243,6 +323,16 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, "404": { "description": "Not found response", "content": { @@ -266,7 +356,7 @@ "$ref": "#/components/parameters/elastic_api_version" }, { - "$ref": "#/components/parameters/kbn-xsrf" + "$ref": "#/components/parameters/kbn_xsrf" } ], "requestBody": { @@ -300,6 +390,26 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, + "403": { + "description": "Forbidden response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/403_response" + } + } + } + }, "404": { "description": "Not found response", "content": { @@ -323,7 +433,7 @@ "$ref": "#/components/parameters/elastic_api_version" }, { - "$ref": "#/components/parameters/kbn-xsrf" + "$ref": "#/components/parameters/kbn_xsrf" }, { "name": "overwrite", @@ -365,6 +475,26 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, + "403": { + "description": "Forbidden response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/403_response" + } + } + } + }, "404": { "description": "Not found response", "content": { @@ -393,7 +523,6 @@ "name": "name", "in": "query", "description": "Service name", - "required": true, "schema": { "type": "string" } @@ -402,7 +531,6 @@ "name": "environment", "in": "query", "description": "Service environment", - "required": true, "schema": { "type": "string" } @@ -429,6 +557,16 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, "404": { "description": "Not found response", "content": { @@ -455,7 +593,7 @@ "$ref": "#/components/parameters/elastic_api_version" }, { - "$ref": "#/components/parameters/kbn-xsrf" + "$ref": "#/components/parameters/kbn_xsrf" } ], "requestBody": { @@ -489,6 +627,16 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, "404": { "description": "Not found response", "content": { @@ -543,6 +691,16 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, "404": { "description": "Not found response", "content": { @@ -599,6 +757,16 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, "404": { "description": "Not found response", "content": { @@ -660,6 +828,16 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, "500": { "description": "Internal Server Error response", "content": { @@ -694,7 +872,7 @@ "$ref": "#/components/parameters/elastic_api_version" }, { - "$ref": "#/components/parameters/kbn-xsrf" + "$ref": "#/components/parameters/kbn_xsrf" } ], "requestBody": { @@ -728,6 +906,26 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, + "403": { + "description": "Forbidden response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/403_response" + } + } + } + }, "500": { "description": "Internal Server Error response", "content": { @@ -764,7 +962,7 @@ "$ref": "#/components/parameters/elastic_api_version" }, { - "$ref": "#/components/parameters/kbn-xsrf" + "$ref": "#/components/parameters/kbn_xsrf" }, { "name": "id", @@ -796,6 +994,26 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, + "403": { + "description": "Forbidden response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/403_response" + } + } + } + }, "500": { "description": "Internal Server Error response", "content": { @@ -831,7 +1049,7 @@ "$ref": "#/components/parameters/elastic_api_version" }, { - "$ref": "#/components/parameters/kbn-xsrf" + "$ref": "#/components/parameters/kbn_xsrf" } ], "requestBody": { @@ -876,6 +1094,26 @@ } } }, + "401": { + "description": "Unauthorized response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/401_response" + } + } + } + }, + "403": { + "description": "Forbidden response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/403_response" + } + } + } + }, "404": { "description": "Not found response", "content": { @@ -905,7 +1143,7 @@ "type": "string" } }, - "kbn-xsrf": { + "kbn_xsrf": { "description": "A required header to protect against CSRF attacks", "in": "header", "name": "kbn-xsrf", @@ -919,6 +1157,10 @@ "schemas": { "agent_keys_object": { "type": "object", + "required": [ + "name", + "privileges" + ], "properties": { "name": { "type": "string" @@ -938,38 +1180,88 @@ "agent_keys_response": { "type": "object", "properties": { - "api_key": { - "type": "string" + "agentKey": { + "type": "object", + "properties": { + "expiration": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "encoded": { + "type": "string" + } + } + } + } + }, + "400_response": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "example": 400 }, - "expiration": { - "type": "integer", - "format": "int64" + "error": { + "type": "string", + "example": "Not Found" }, - "id": { - "type": "string" + "message": { + "type": "string", + "example": "Not Found" + } + } + }, + "401_response": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "example": 401 }, - "name": { - "type": "string" + "error": { + "type": "string", + "example": "Unauthorized" }, - "encoded": { + "message": { "type": "string" } } }, - "400_response": { + "403_response": { "type": "object", "properties": { "statusCode": { "type": "number", - "example": 400 + "example": 403 }, "error": { "type": "string", - "example": "Not Found" + "example": "Forbidden" }, "message": { + "type": "string" + } + } + }, + "500_response": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "example": 500 + }, + "error": { "type": "string", - "example": "Not Found" + "example": "Internal Server Error" + }, + "message": { + "type": "string" } } }, @@ -1082,6 +1374,23 @@ } } }, + "404_response": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "example": 404 + }, + "error": { + "type": "string", + "example": "Not Found" + }, + "message": { + "type": "string", + "example": "Not Found" + } + } + }, "service_object": { "type": "object", "properties": { @@ -1139,23 +1448,6 @@ } } }, - "404_response": { - "type": "object", - "properties": { - "statusCode": { - "type": "number", - "example": 404 - }, - "error": { - "type": "string", - "example": "Not Found" - }, - "message": { - "type": "string", - "example": "Not Found" - } - } - }, "agent_configuration_intake_object": { "type": "object", "required": [ @@ -1356,22 +1648,6 @@ } } }, - "500_response": { - "type": "object", - "properties": { - "statusCode": { - "type": "number", - "example": 500 - }, - "error": { - "type": "string", - "example": "Internal Server Error" - }, - "message": { - "type": "string" - } - } - }, "501_response": { "type": "object", "properties": { diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.yaml index 28b483cce5ad5..d3c14cd0ed8f8 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/bundled.yaml @@ -26,7 +26,7 @@ paths: - APM agent keys parameters: - $ref: '#/components/parameters/elastic_api_version' - - $ref: '#/components/parameters/kbn-xsrf' + - $ref: '#/components/parameters/kbn_xsrf' requestBody: required: true content: @@ -46,6 +46,24 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/403_response' + '500': + description: Internal Server Error response + content: + application/json: + schema: + $ref: '#/components/schemas/500_response' /api/apm/services/{serviceName}/annotation/search: get: summary: Search for annotations @@ -92,6 +110,18 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' + '500': + description: Internal Server Error response + content: + application/json: + schema: + $ref: '#/components/schemas/500_response' /api/apm/services/{serviceName}/annotation: post: summary: Create a service annotation @@ -101,7 +131,7 @@ paths: - APM annotations parameters: - $ref: '#/components/parameters/elastic_api_version' - - $ref: '#/components/parameters/kbn-xsrf' + - $ref: '#/components/parameters/kbn_xsrf' - name: serviceName in: path required: true @@ -127,6 +157,24 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/403_response' + '404': + description: Not found response + content: + application/json: + schema: + $ref: '#/components/schemas/404_response' /api/apm/settings/agent-configuration: get: summary: List of agent configurations @@ -149,6 +197,12 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' '404': description: Not found response content: @@ -162,7 +216,7 @@ paths: - APM agent configuration parameters: - $ref: '#/components/parameters/elastic_api_version' - - $ref: '#/components/parameters/kbn-xsrf' + - $ref: '#/components/parameters/kbn_xsrf' requestBody: required: true content: @@ -182,6 +236,18 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/403_response' '404': description: Not found response content: @@ -195,7 +261,7 @@ paths: - APM agent configuration parameters: - $ref: '#/components/parameters/elastic_api_version' - - $ref: '#/components/parameters/kbn-xsrf' + - $ref: '#/components/parameters/kbn_xsrf' - name: overwrite in: query schema: @@ -220,6 +286,18 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/403_response' '404': description: Not found response content: @@ -237,13 +315,11 @@ paths: - name: name in: query description: Service name - required: true schema: type: string - name: environment in: query description: Service environment - required: true schema: type: string responses: @@ -259,6 +335,12 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' '404': description: Not found response content: @@ -275,7 +357,7 @@ paths: - APM agent configuration parameters: - $ref: '#/components/parameters/elastic_api_version' - - $ref: '#/components/parameters/kbn-xsrf' + - $ref: '#/components/parameters/kbn_xsrf' requestBody: required: true content: @@ -295,6 +377,12 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' '404': description: Not found response content: @@ -327,6 +415,12 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' '404': description: Not found response content: @@ -361,6 +455,12 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' '404': description: Not found response content: @@ -397,6 +497,12 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' '500': description: Internal Server Error response content: @@ -417,7 +523,7 @@ paths: - APM sourcemaps parameters: - $ref: '#/components/parameters/elastic_api_version' - - $ref: '#/components/parameters/kbn-xsrf' + - $ref: '#/components/parameters/kbn_xsrf' requestBody: required: true content: @@ -437,6 +543,18 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/403_response' '500': description: Internal Server Error response content: @@ -458,7 +576,7 @@ paths: - APM sourcemaps parameters: - $ref: '#/components/parameters/elastic_api_version' - - $ref: '#/components/parameters/kbn-xsrf' + - $ref: '#/components/parameters/kbn_xsrf' - name: id in: path schema: @@ -477,6 +595,18 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/403_response' '500': description: Internal Server Error response content: @@ -497,7 +627,7 @@ paths: - APM server schema parameters: - $ref: '#/components/parameters/elastic_api_version' - - $ref: '#/components/parameters/kbn-xsrf' + - $ref: '#/components/parameters/kbn_xsrf' requestBody: required: true content: @@ -525,6 +655,18 @@ paths: application/json: schema: $ref: '#/components/schemas/400_response' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/401_response' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/403_response' '404': description: Not found response content: @@ -543,7 +685,7 @@ components: enum: - '2023-10-31' type: string - kbn-xsrf: + kbn_xsrf: description: A required header to protect against CSRF attacks in: header name: kbn-xsrf @@ -554,6 +696,9 @@ components: schemas: agent_keys_object: type: object + required: + - name + - privileges properties: name: type: string @@ -567,17 +712,18 @@ components: agent_keys_response: type: object properties: - api_key: - type: string - expiration: - type: integer - format: int64 - id: - type: string - name: - type: string - encoded: - type: string + agentKey: + type: object + properties: + expiration: + type: integer + format: int64 + id: + type: string + name: + type: string + encoded: + type: string 400_response: type: object properties: @@ -590,6 +736,39 @@ components: message: type: string example: Not Found + 401_response: + type: object + properties: + statusCode: + type: number + example: 401 + error: + type: string + example: Unauthorized + message: + type: string + 403_response: + type: object + properties: + statusCode: + type: number + example: 403 + error: + type: string + example: Forbidden + message: + type: string + 500_response: + type: object + properties: + statusCode: + type: number + example: 500 + error: + type: string + example: Internal Server Error + message: + type: string annotation_search_response: type: object properties: @@ -660,6 +839,18 @@ components: type: string '@timestamp': type: string + 404_response: + type: object + properties: + statusCode: + type: number + example: 404 + error: + type: string + example: Not Found + message: + type: string + example: Not Found service_object: type: object properties: @@ -698,18 +889,6 @@ components: type: array items: $ref: '#/components/schemas/agent_configuration_object' - 404_response: - type: object - properties: - statusCode: - type: number - example: 404 - error: - type: string - example: Not Found - message: - type: string - example: Not Found agent_configuration_intake_object: type: object required: @@ -837,17 +1016,6 @@ components: sourceRoot: type: string - $ref: '#/components/schemas/base_source_map_object' - 500_response: - type: object - properties: - statusCode: - type: number - example: 500 - error: - type: string - example: Internal Server Error - message: - type: string 501_response: type: object properties: diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/401_response.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/401_response.yaml new file mode 100644 index 0000000000000..efed1377e3fe1 --- /dev/null +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/401_response.yaml @@ -0,0 +1,10 @@ +type: object +properties: + statusCode: + type: number + example: 401 + error: + type: string + example: Unauthorized + message: + type: string diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/403_response.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/403_response.yaml new file mode 100644 index 0000000000000..b339ad639fd5c --- /dev/null +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/403_response.yaml @@ -0,0 +1,10 @@ +type: object +properties: + statusCode: + type: number + example: 403 + error: + type: string + example: Forbidden + message: + type: string diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_object.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_object.yaml index 756bb5420b82b..0eecaeddc081b 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_object.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_object.yaml @@ -1,4 +1,7 @@ type: object +required: + - name + - privileges properties: name: type: string diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_response.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_response.yaml index 9335c3fb58e52..36cdb697ba4e7 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_response.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_response.yaml @@ -1,13 +1,14 @@ type: object properties: - api_key: - type: string - expiration: - type: integer - format: int64 - id: - type: string - name: - type: string - encoded: - type: string + agentKey: + type: object + properties: + expiration: + type: integer + format: int64 + id: + type: string + name: + type: string + encoded: + type: string diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@agent_keys.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@agent_keys.yaml index 8baa9600f1358..46b1588517761 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@agent_keys.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@agent_keys.yaml @@ -26,3 +26,21 @@ post: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '../components/schemas/403_response.yaml' + '500': + description: Internal Server Error response + content: + application/json: + schema: + $ref: '../components/schemas/500_response.yaml' diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@fleet@apm_server_schema.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@fleet@apm_server_schema.yaml index 70fb9de3df1da..2c4629b44a211 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@fleet@apm_server_schema.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@fleet@apm_server_schema.yaml @@ -33,6 +33,18 @@ post: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '../components/schemas/403_response.yaml' '404': description: Not found response content: diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@annotation.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@annotation.yaml index 17973858f7711..3894bd6da2015 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@annotation.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@annotation.yaml @@ -32,3 +32,21 @@ post: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '../components/schemas/403_response.yaml' + '404': + description: Not found response + content: + application/json: + schema: + $ref: '../components/schemas/404_response.yaml' diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@annotation@search.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@annotation@search.yaml index edb8bc2cb5b06..0f1391be89806 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@annotation@search.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@annotation@search.yaml @@ -43,3 +43,15 @@ get: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' + '500': + description: Internal Server Error response + content: + application/json: + schema: + $ref: '../components/schemas/500_response.yaml' diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration.yaml index 45dc5a21f8b18..c7d7251d1d8fb 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration.yaml @@ -19,6 +19,12 @@ get: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' '404': description: Not found response content: @@ -52,6 +58,18 @@ delete: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '../components/schemas/403_response.yaml' '404': description: Not found response content: @@ -90,6 +108,18 @@ put: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '../components/schemas/403_response.yaml' '404': description: Not found response content: diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@agent_name.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@agent_name.yaml index af5689b021a3d..a1f3b13451d6a 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@agent_name.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@agent_name.yaml @@ -25,6 +25,12 @@ get: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' '404': description: Not found response content: diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@search.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@search.yaml index c253f20746c1a..8ae4ce975fc08 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@search.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@search.yaml @@ -27,6 +27,12 @@ post: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' '404': description: Not found response content: diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@view.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@view.yaml index 127f877aa359b..c32bac7df383c 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@view.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@view.yaml @@ -8,13 +8,11 @@ get: - name: name in: query description: Service name - required: true schema: type: string - name: environment in: query description: Service environment - required: true schema: type: string responses: @@ -30,6 +28,12 @@ get: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' '404': description: Not found response content: diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@sourcemaps.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@sourcemaps.yaml index 48fbdebc949df..0c70853bca01e 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@sourcemaps.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@sourcemaps.yaml @@ -27,6 +27,12 @@ get: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' '500': description: Internal Server Error response content: @@ -67,6 +73,18 @@ post: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '../components/schemas/403_response.yaml' '500': description: Internal Server Error response content: diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@sourcemaps@{id}.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@sourcemaps@{id}.yaml index 57e7ce141652f..4a6685dc2be38 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@sourcemaps@{id}.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@sourcemaps@{id}.yaml @@ -25,6 +25,18 @@ delete: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' + '403': + description: Forbidden response + content: + application/json: + schema: + $ref: '../components/schemas/403_response.yaml' '500': description: Internal Server Error response content: diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/apm@settings@agent_configuration@environments.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/apm@settings@agent_configuration@environments.yaml index e40943cd23f45..c0791b92ac148 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/apm@settings@agent_configuration@environments.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/apm@settings@agent_configuration@environments.yaml @@ -23,6 +23,12 @@ get: application/json: schema: $ref: '../components/schemas/400_response.yaml' + '401': + description: Unauthorized response + content: + application/json: + schema: + $ref: '../components/schemas/401_response.yaml' '404': description: Not found response content: