adjust specs

elastic · Oct 31, 2024 · ffaf2bb · ffaf2bb
1 parent f8e3ac5
commit ffaf2bb
Show file tree

Hide file tree

Showing 13 changed files with 52 additions and 15 deletions.
diff --git a/...vability_solution/apm/docs/openapi/apm/components/schemas/agent_configuration_object.yaml b/...vability_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/...s/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_response.yaml b/...s/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/...ervability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_object.yaml b/...ervability_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/...vability_solution/apm/docs/openapi/apm/components/schemas/create_annotation_response.yaml b/...vability_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/...y_solution/apm/docs/openapi/apm/components/schemas/search_agent_configuration_object.yaml b/...y_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/...ability_solution/apm/docs/openapi/apm/components/schemas/service_agent_name_response.yaml b/...ability_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/...vability_solution/apm/docs/openapi/apm/components/schemas/service_environment_object.yaml b/...vability_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/...lugins/observability_solution/apm/docs/openapi/apm/components/schemas/service_object.yaml b/...lugins/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/.../observability_solution/apm/docs/openapi/apm/components/schemas/source_maps_response.yaml b/.../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
@@ -31,7 +31,7 @@ paths:
   /api/apm/settings/agent-configuration/search:
     $ref: 'paths/api@apm@settings@[email protected]'
   /api/apm/settings/agent-configuration/environments:
-    $ref: 'paths/apm@settings@[email protected]'
+    $ref: 'paths/api@apm@settings@[email protected]'
   /api/apm/settings/agent-configuration/agent_name:
     $ref: 'paths/api@apm@settings@agent_configuration@agent_name.yaml'
   /api/apm/sourcemaps:

diff --git a/..._solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration@agent_name.yaml b/..._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/...ngs@[email protected] → ...ngs@[email protected] b/...ngs@[email protected] → ...ngs@[email protected]
diff --git a/...bility_solution/apm/docs/openapi/apm/paths/api@apm@settings@[email protected] b/...bility_solution/apm/docs/openapi/apm/paths/api@apm@settings@[email protected]
@@ -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