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 940979f3ddbbd..3c51e202898c2 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 @@ -525,7 +525,8 @@ "description": "Service name", "schema": { "type": "string" - } + }, + "example": "node" }, { "name": "environment", @@ -533,7 +534,8 @@ "description": "Service environment", "schema": { "type": "string" - } + }, + "example": "prod" } ], "responses": { @@ -733,7 +735,8 @@ "required": true, "schema": { "type": "string" - } + }, + "example": "node" } ], "responses": { @@ -1182,6 +1185,12 @@ "properties": { "agentKey": { "type": "object", + "required": [ + "id", + "name", + "api_key", + "encoded" + ], "properties": { "expiration": { "type": "integer", @@ -1193,6 +1202,9 @@ "name": { "type": "string" }, + "api_key": { + "type": "string" + }, "encoded": { "type": "string" } @@ -1295,12 +1307,19 @@ }, "create_annotation_object": { "type": "object", + "required": [ + "@timestamp", + "service" + ], "properties": { "@timestamp": { "type": "string" }, "service": { "type": "object", + "required": [ + "version" + ], "properties": { "version": { "type": "string" @@ -1334,7 +1353,15 @@ "type": "object", "properties": { "annotation": { - "type": "string" + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "title": { + "type": "string" + } + } }, "tags": { "type": "array", @@ -1395,10 +1422,12 @@ "type": "object", "properties": { "name": { - "type": "string" + "type": "string", + "example": "node" }, "environment": { - "type": "string" + "type": "string", + "example": "prod" } } }, @@ -1427,13 +1456,16 @@ "$ref": "#/components/schemas/settings_object" }, "@timestamp": { - "type": "number" + "type": "number", + "example": 1730194190636 }, "applied_by_agent": { - "type": "boolean" + "type": "boolean", + "example": true }, "etag": { - "type": "string" + "type": "string", + "example": "0bc3b5ebf18fba8163fe4c96f491e3767a358f85" } } }, @@ -1503,7 +1535,8 @@ }, "etag": { "type": "string", - "description": "If etags match then `applied_by_agent` field will be set to `true`" + "description": "If etags match then `applied_by_agent` field will be set to `true`", + "example": "0bc3b5ebf18fba8163fe4c96f491e3767a358f85" }, "mark_as_applied_by_agent": { "type": "boolean", @@ -1532,7 +1565,8 @@ "type": "object", "properties": { "name": { - "type": "string" + "type": "string", + "example": "ALL_OPTION_VALUE" }, "alreadyConfigured": { "type": "boolean" @@ -1554,7 +1588,8 @@ "type": "object", "properties": { "agentName": { - "type": "string" + "type": "string", + "example": "nodejs" } } }, @@ -1612,29 +1647,43 @@ "body": { "type": "object", "properties": { - "version": { - "type": "number" - }, - "file": { + "serviceName": { "type": "string" }, - "sources": { - "type": "array", - "items": { - "type": "string" - } - }, - "sourcesContent": { - "type": "array", - "items": { - "type": "string" - } - }, - "mappings": { + "serviceVersion": { "type": "string" }, - "sourceRoot": { + "bundleFilepath": { "type": "string" + }, + "sourceMap": { + "type": "object", + "properties": { + "version": { + "type": "number" + }, + "file": { + "type": "string" + }, + "sources": { + "type": "array", + "items": { + "type": "string" + } + }, + "sourcesContent": { + "type": "array", + "items": { + "type": "string" + } + }, + "mappings": { + "type": "string" + }, + "sourceRoot": { + "type": "string" + } + } } } } 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 d3c14cd0ed8f8..e5678dcde3766 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 @@ -317,11 +317,13 @@ paths: description: Service name schema: type: string + example: node - name: environment in: query description: Service environment schema: type: string + example: prod responses: '200': description: Successful response @@ -442,6 +444,7 @@ paths: required: true schema: type: string + example: node responses: '200': description: Successful response @@ -714,6 +717,11 @@ components: properties: agentKey: type: object + required: + - id + - name + - api_key + - encoded properties: expiration: type: integer @@ -722,6 +730,8 @@ components: type: string name: type: string + api_key: + type: string encoded: type: string 400_response: @@ -789,11 +799,16 @@ components: type: string create_annotation_object: type: object + required: + - '@timestamp' + - service properties: '@timestamp': type: string service: type: object + required: + - version properties: version: type: string @@ -816,7 +831,12 @@ components: type: object properties: annotation: - type: string + type: object + properties: + type: + type: string + title: + type: string tags: type: array items: @@ -856,8 +876,10 @@ components: properties: name: type: string + example: node environment: type: string + example: prod settings_object: type: object additionalProperties: @@ -878,10 +900,13 @@ components: $ref: '#/components/schemas/settings_object' '@timestamp': type: number + example: 1730194190636 applied_by_agent: type: boolean + example: true etag: type: string + example: 0bc3b5ebf18fba8163fe4c96f491e3767a358f85 agent_configurations_response: type: object properties: @@ -925,6 +950,7 @@ components: etag: type: string description: If etags match then `applied_by_agent` field will be set to `true` + example: 0bc3b5ebf18fba8163fe4c96f491e3767a358f85 mark_as_applied_by_agent: type: boolean description: | @@ -946,6 +972,7 @@ components: properties: name: type: string + example: ALL_OPTION_VALUE alreadyConfigured: type: boolean service_environments_response: @@ -960,6 +987,7 @@ components: properties: agentName: type: string + example: nodejs base_source_map_object: type: object properties: @@ -999,22 +1027,31 @@ components: body: type: object properties: - version: - type: number - file: + serviceName: type: string - sources: - type: array - items: - type: string - sourcesContent: - type: array - items: - type: string - mappings: + serviceVersion: type: string - sourceRoot: + bundleFilepath: type: string + sourceMap: + type: object + properties: + version: + type: number + file: + type: string + sources: + type: array + items: + type: string + sourcesContent: + type: array + items: + type: string + mappings: + type: string + sourceRoot: + type: string - $ref: '#/components/schemas/base_source_map_object' 501_response: type: object diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_configuration_object.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_configuration_object.yaml index 0c3c7c44d7e04..c4f05244709cc 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_configuration_object.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_configuration_object.yaml @@ -13,7 +13,10 @@ properties: $ref: 'settings_object.yaml' '@timestamp': type: number + example: 1730194190636 applied_by_agent: type: boolean + example: true etag: type: string + example: 0bc3b5ebf18fba8163fe4c96f491e3767a358f85 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 36cdb697ba4e7..025223bf6c7c7 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 @@ -2,6 +2,11 @@ type: object properties: agentKey: type: object + required: + - id + - name + - api_key + - encoded properties: expiration: type: integer @@ -10,5 +15,7 @@ properties: type: string name: type: string + api_key: + type: string encoded: type: string diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_object.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_object.yaml index a262cd386d073..4865d75797905 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_object.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_object.yaml @@ -1,9 +1,14 @@ type: object +required: + - '@timestamp' + - service properties: '@timestamp': type: string service: type: object + required: + - version properties: version: type: string diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_response.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_response.yaml index 4f70f6744265e..2a9edf031c489 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_response.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_response.yaml @@ -8,7 +8,12 @@ properties: type: object properties: annotation: - type: string + type: object + properties: + type: + type: string + title: + type: string tags: type: array items: diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/search_agent_configuration_object.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/search_agent_configuration_object.yaml index ae0a884d53f87..abbbf91b77b89 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/search_agent_configuration_object.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/search_agent_configuration_object.yaml @@ -7,6 +7,7 @@ properties: etag: type: string description: If etags match then `applied_by_agent` field will be set to `true` + example: 0bc3b5ebf18fba8163fe4c96f491e3767a358f85 mark_as_applied_by_agent: type: boolean description: | diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_agent_name_response.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_agent_name_response.yaml index b318e4f725f20..4e66198cf09ad 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_agent_name_response.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_agent_name_response.yaml @@ -2,3 +2,4 @@ type: object properties: agentName: type: string + example: nodejs diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_environment_object.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_environment_object.yaml index aac94236d65c6..00322668e8dd1 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_environment_object.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_environment_object.yaml @@ -2,5 +2,6 @@ type: object properties: name: type: string + example: ALL_OPTION_VALUE alreadyConfigured: type: boolean diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_object.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_object.yaml index 562856349206e..192cefdcdd807 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_object.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_object.yaml @@ -2,5 +2,7 @@ type: object properties: name: type: string + example: node environment: type: string + example: prod diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/source_maps_response.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/source_maps_response.yaml index 07ee5f6c8e0e5..1856aa32ca045 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/source_maps_response.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/components/schemas/source_maps_response.yaml @@ -9,20 +9,29 @@ properties: body: type: object properties: - version: - type: number - file: + serviceName: type: string - sources: - type: array - items: - type: string - sourcesContent: - type: array - items: - type: string - mappings: + serviceVersion: type: string - sourceRoot: + bundleFilepath: type: string + sourceMap: + type: object + properties: + version: + type: number + file: + type: string + sources: + type: array + items: + type: string + sourcesContent: + type: array + items: + type: string + mappings: + type: string + sourceRoot: + type: string - $ref: 'base_source_map_object.yaml' diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/entrypoint.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/entrypoint.yaml index e4b8a80fa1e5a..7a94d2470bc3d 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm/entrypoint.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/entrypoint.yaml @@ -31,7 +31,7 @@ paths: /api/apm/settings/agent-configuration/search: $ref: 'paths/api@apm@settings@agent_configuration@search.yaml' /api/apm/settings/agent-configuration/environments: - $ref: 'paths/apm@settings@agent_configuration@environments.yaml' + $ref: 'paths/api@apm@settings@agent_configuration@environments.yaml' /api/apm/settings/agent-configuration/agent_name: $ref: 'paths/api@apm@settings@agent_configuration@agent_name.yaml' /api/apm/sourcemaps: 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 a1f3b13451d6a..4ad10fbb00833 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 @@ -12,6 +12,7 @@ get: required: true schema: type: string + example: node responses: '200': description: Successful response 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/api@apm@settings@agent_configuration@environments.yaml similarity index 100% rename from x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/apm@settings@agent_configuration@environments.yaml rename to x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@environments.yaml 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 c32bac7df383c..23e5cc2186d12 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 @@ -10,11 +10,13 @@ get: description: Service name schema: type: string + example: node - name: environment in: query description: Service environment schema: type: string + example: prod responses: '200': description: Successful response