add missing http responses

elastic · Oct 30, 2024 · f8e3ac5 · f8e3ac5
1 parent 4dc008d
commit f8e3ac5
Show file tree

Hide file tree

Showing 17 changed files with 726 additions and 116 deletions.
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
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
diff --git a/.../plugins/observability_solution/apm/docs/openapi/apm/components/schemas/401_response.yaml b/.../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/.../plugins/observability_solution/apm/docs/openapi/apm/components/schemas/403_response.yaml b/.../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/...ins/observability_solution/apm/docs/openapi/apm/components/schemas/agent_keys_object.yaml b/...ins/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/...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
@@ -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
@@ -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/...ns/observability_solution/apm/docs/openapi/apm/paths/api@apm@fleet@apm_server_schema.yaml b/...ns/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/...bility_solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@annotation.yaml b/...bility_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/...solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@[email protected] b/...solution/apm/docs/openapi/apm/paths/api@apm@services@{serviceName}@[email protected]
@@ -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/...servability_solution/apm/docs/openapi/apm/paths/api@apm@settings@agent_configuration.yaml b/...servability_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/..._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
@@ -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/...lity_solution/apm/docs/openapi/apm/paths/api@apm@settings@[email protected] b/...lity_solution/apm/docs/openapi/apm/paths/api@apm@settings@[email protected]
@@ -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/...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]
@@ -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@[email protected] b/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api@[email protected]
@@ -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/...ck/plugins/observability_solution/apm/docs/openapi/apm/paths/api@apm@sourcemaps@{id}.yaml b/...ck/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/...ty_solution/apm/docs/openapi/apm/paths/apm@settings@[email protected] b/...ty_solution/apm/docs/openapi/apm/paths/apm@settings@[email protected]
@@ -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: