[Fleet] Removes messageSigningService api definition from openApi spec (

elastic#156376) ## Summary - Removes message signing service api definition from openAPI spec. - Updates warning message when `acknowledge` param is missing or set to false.
kibanamachine · May 2, 2023 · b961399 · b961399
1 parent 8da8f89
commit b961399
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 105 deletions.
diff --git a/x-pack/plugins/fleet/common/openapi/bundled.json b/x-pack/plugins/fleet/common/openapi/bundled.json
@@ -3402,46 +3402,6 @@
       },
       "parameters": []
     },
-    "/message_signing_service/rotate_key_pair": {
-      "post": {
-        "summary": "Rotate key pair",
-        "tags": [
-          "Message Signing Service"
-        ],
-        "operationId": "rotate-key-pair",
-        "parameters": [
-          {
-            "schema": {
-              "type": "boolean"
-            },
-            "in": "query",
-            "name": "acknowledge",
-            "required": true,
-            "description": "When set to true, rotate key pair is done. If set to false or missing, it returns an error."
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "message": {
-                      "type": "string"
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "400": {
-            "$ref": "#/components/responses/error"
-          }
-        }
-      }
-    },
     "/data_streams": {
       "get": {
         "summary": "List data streams",

diff --git a/x-pack/plugins/fleet/common/openapi/bundled.yaml b/x-pack/plugins/fleet/common/openapi/bundled.yaml
@@ -2113,33 +2113,6 @@ paths:
       parameters:
         - $ref: '#/components/parameters/kbn_xsrf'
     parameters: []
-  /message_signing_service/rotate_key_pair:
-    post:
-      summary: Rotate key pair
-      tags:
-        - Message Signing Service
-      operationId: rotate-key-pair
-      parameters:
-        - schema:
-            type: boolean
-          in: query
-          name: acknowledge
-          required: true
-          description: >-
-            When set to true, rotate key pair is done. If set to false or
-            missing, it returns an error.
-      responses:
-        '200':
-          description: OK
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  message:
-                    type: string
-        '400':
-          $ref: '#/components/responses/error'
   /data_streams:
     get:
       summary: List data streams

diff --git a/x-pack/plugins/fleet/common/openapi/entrypoint.yaml b/x-pack/plugins/fleet/common/openapi/entrypoint.yaml
@@ -105,10 +105,6 @@ paths:
   /agent_policies/delete:
     $ref: paths/agent_policies@delete.yaml
 
-  # Message signing service
-  /message_signing_service/rotate_key_pair:
-   $ref: paths/message_signing_service@rotate_key_pair.yaml
-
   # Data streams endpoints
   /data_streams:
     $ref: paths/data_streams.yaml

diff --git a/x-pack/plugins/fleet/common/openapi/paths/message_signing_service@rotate_key_pair.yaml b/x-pack/plugins/fleet/common/openapi/paths/message_signing_service@rotate_key_pair.yaml
diff --git a/x-pack/plugins/fleet/server/types/rest_spec/message_signing_service.test.ts b/x-pack/plugins/fleet/server/types/rest_spec/message_signing_service.test.ts
@@ -5,23 +5,19 @@
  * 2.0.
  */
 
-import { RotateKeyPairSchema } from './message_signing_service';
+import { errorMessage, RotateKeyPairSchema } from './message_signing_service';
 
 describe('RotateKeyPairSchema', () => {
   it('should throw on `false` values for acknowledge', () => {
     expect(() =>
       RotateKeyPairSchema.query.validate({
         acknowledge: false,
       })
-    ).toThrowError(
-      'You must acknowledge the risks of rotating the key pair with acknowledge=true in the request parameters.'
-    );
+    ).toThrowError(errorMessage);
   });
 
   it('should allow without any query', () => {
-    expect(() => RotateKeyPairSchema.query.validate({})).toThrowError(
-      'You must acknowledge the risks of rotating the key pair with acknowledge=true in the request parameters.'
-    );
+    expect(() => RotateKeyPairSchema.query.validate({})).toThrowError(errorMessage);
   });
 
   it.each([1, 'string'])('should not allow non-boolean `%s` values for acknowledge', (value) => {

diff --git a/x-pack/plugins/fleet/server/types/rest_spec/message_signing_service.ts b/x-pack/plugins/fleet/server/types/rest_spec/message_signing_service.ts
@@ -7,6 +7,8 @@
 
 import { schema } from '@kbn/config-schema';
 
+export const errorMessage =
+  'Warning: this API will cause a key pair to rotate and should not be necessary in normal operation.  If you proceed, you may need to reinstall Agents in your network. You must acknowledge the risks of rotating the key pair with acknowledge=true in the request parameters.  For more information, reach out to your administrator.';
 export const RotateKeyPairSchema = {
   query: schema.maybe(
     schema.object(
@@ -19,9 +21,7 @@ export const RotateKeyPairSchema = {
         defaultValue: { acknowledge: false },
         validate: (value: { acknowledge: boolean }) => {
           if (!value || !value.acknowledge) {
-            throw new Error(
-              'You must acknowledge the risks of rotating the key pair with acknowledge=true in the request parameters.'
-            );
+            throw new Error(errorMessage);
           }
         },
       }