Changed actions API endpoints urls to follow Kibana STYLEGUIDE (#65936)

* Changed actions API endpoints urls to follow Kibana STYLEGUIDE * Fixed tests * fixed test * fixed test * resolved conflicts * Fixed siem tests * Fixed failing test * fixed readme and test * Changed actions api urls to follow the template 'api/{plugin}/{type}/{id} * Fixed type checks * Fixed tests and API * fixed tests * Fixed type checks * fixed type check
elastic · May 25, 2020 · d09bd63 · d09bd63
1 parent 66a0e67
commit d09bd63
Show file tree

Hide file tree

Showing 93 changed files with 395 additions and 384 deletions.
diff --git a/x-pack/plugins/actions/README.md b/x-pack/plugins/actions/README.md
@@ -27,12 +27,12 @@ Table of Contents
     - [Example](#example)
   - [RESTful API](#restful-api)
     - [`POST /api/action`: Create action](#post-apiaction-create-action)
-    - [`DELETE /api/action/{id}`: Delete action](#delete-apiactionid-delete-action)
-    - [`GET /api/action/_getAll`: Get all actions](#get-apiactiongetall-get-all-actions)
-    - [`GET /api/action/{id}`: Get action](#get-apiactionid-get-action)
-    - [`GET /api/action/types`: List action types](#get-apiactiontypes-list-action-types)
-    - [`PUT /api/action/{id}`: Update action](#put-apiactionid-update-action)
-    - [`POST /api/action/{id}/_execute`: Execute action](#post-apiactionidexecute-execute-action)
+    - [`DELETE /api/actions/action/{id}`: Delete action](#delete-apiactionid-delete-action)
+    - [`GET /api/actions`: Get all actions](#get-apiactiongetall-get-all-actions)
+    - [`GET /api/actions/action/{id}`: Get action](#get-apiactionid-get-action)
+    - [`GET /api/actions/list_action_types`: List action types](#get-apiactiontypes-list-action-types)
+    - [`PUT /api/actions/action/{id}`: Update action](#put-apiactionid-update-action)
+    - [`POST /api/actions/action/{id}/_execute`: Execute action](#post-apiactionidexecute-execute-action)
   - [Firing actions](#firing-actions)
   - [Example](#example-1)
 - [Built-in Action Types](#built-in-action-types)
@@ -174,35 +174,35 @@ Payload:
 | config       | The configuration the action type expects. See related action type to see what attributes are expected. This will also validate against the action type if config validation is defined. | object |
 | secrets      | The secrets the action type expects. See related action type to see what attributes are expected. This will also validate against the action type if secrets validation is defined.      | object |
 
-### `DELETE /api/action/{id}`: Delete action
+### `DELETE /api/actions/action/{id}`: Delete action
 
 Params:
 
 | Property | Description                                   | Type   |
 | -------- | --------------------------------------------- | ------ |
 | id       | The id of the action you're trying to delete. | string |
 
-### `GET /api/action/_getAll`: Get all actions
+### `GET /api/actions`: Get all actions
 
 No parameters.
 
 Return all actions from saved objects merged with predefined list.
 Use the [saved objects API for find](https://www.elastic.co/guide/en/kibana/master/saved-objects-api-find.html) with the proprties: `type: 'action'` and `perPage: 10000`.
 List of predefined actions should be set up in Kibana.yaml.
 
-### `GET /api/action/{id}`: Get action
+### `GET /api/actions/action/{id}`: Get action
 
 Params:
 
 | Property | Description                                | Type   |
 | -------- | ------------------------------------------ | ------ |
 | id       | The id of the action you're trying to get. | string |
 
-### `GET /api/action/types`: List action types
+### `GET /api/actions/list_action_types`: List action types
 
 No parameters.
 
-### `PUT /api/action/{id}`: Update action
+### `PUT /api/actions/action/{id}`: Update action
 
 Params:
 
@@ -218,7 +218,7 @@ Payload:
 | config   | The configuration the action type expects. See related action type to see what attributes are expected. This will also validate against the action type if config validation is defined. | object |
 | secrets  | The secrets the action type expects. See related action type to see what attributes are expected. This will also validate against the action type if secrets validation is defined.      | object |
 
-### `POST /api/action/{id}/_execute`: Execute action
+### `POST /api/actions/action/{id}/_execute`: Execute action
 
 Params:
 

diff --git a/x-pack/plugins/actions/common/index.ts b/x-pack/plugins/actions/common/index.ts
@@ -6,4 +6,4 @@
 
 export * from './types';
 
-export const BASE_ACTION_API_PATH = '/api/action';
+export const BASE_ACTION_API_PATH = '/api/actions';
diff --git a/x-pack/plugins/actions/server/routes/create.test.ts b/x-pack/plugins/actions/server/routes/create.test.ts
@@ -27,7 +27,7 @@ describe('createActionRoute', () => {
 
     const [config, handler] = router.post.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions/action"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [

diff --git a/x-pack/plugins/actions/server/routes/create.ts b/x-pack/plugins/actions/server/routes/create.ts
@@ -26,7 +26,7 @@ export const bodySchema = schema.object({
 export const createActionRoute = (router: IRouter, licenseState: ILicenseState) => {
   router.post(
     {
-      path: BASE_ACTION_API_PATH,
+      path: `${BASE_ACTION_API_PATH}/action`,
       validate: {
         body: bodySchema,
       },

diff --git a/x-pack/plugins/actions/server/routes/delete.test.ts b/x-pack/plugins/actions/server/routes/delete.test.ts
@@ -27,7 +27,7 @@ describe('deleteActionRoute', () => {
 
     const [config, handler] = router.delete.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/{id}"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions/action/{id}"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [

diff --git a/x-pack/plugins/actions/server/routes/delete.ts b/x-pack/plugins/actions/server/routes/delete.ts
@@ -27,7 +27,7 @@ const paramSchema = schema.object({
 export const deleteActionRoute = (router: IRouter, licenseState: ILicenseState) => {
   router.delete(
     {
-      path: `${BASE_ACTION_API_PATH}/{id}`,
+      path: `${BASE_ACTION_API_PATH}/action/{id}`,
       validate: {
         params: paramSchema,
       },

diff --git a/x-pack/plugins/actions/server/routes/execute.test.ts b/x-pack/plugins/actions/server/routes/execute.test.ts
@@ -53,7 +53,7 @@ describe('executeActionRoute', () => {
 
     const [config, handler] = router.post.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/{id}/_execute"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions/action/{id}/_execute"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [

diff --git a/x-pack/plugins/actions/server/routes/execute.ts b/x-pack/plugins/actions/server/routes/execute.ts
@@ -32,7 +32,7 @@ export const executeActionRoute = (
 ) => {
   router.post(
     {
-      path: `${BASE_ACTION_API_PATH}/{id}/_execute`,
+      path: `${BASE_ACTION_API_PATH}/action/{id}/_execute`,
       validate: {
         body: bodySchema,
         params: paramSchema,

diff --git a/x-pack/plugins/actions/server/routes/get.test.ts b/x-pack/plugins/actions/server/routes/get.test.ts
@@ -28,7 +28,7 @@ describe('getActionRoute', () => {
 
     const [config, handler] = router.get.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/{id}"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions/action/{id}"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [

diff --git a/x-pack/plugins/actions/server/routes/get.ts b/x-pack/plugins/actions/server/routes/get.ts
@@ -22,7 +22,7 @@ const paramSchema = schema.object({
 export const getActionRoute = (router: IRouter, licenseState: ILicenseState) => {
   router.get(
     {
-      path: `${BASE_ACTION_API_PATH}/{id}`,
+      path: `${BASE_ACTION_API_PATH}/action/{id}`,
       validate: {
         params: paramSchema,
       },

diff --git a/x-pack/plugins/actions/server/routes/get_all.test.ts b/x-pack/plugins/actions/server/routes/get_all.test.ts
@@ -28,7 +28,7 @@ describe('getAllActionRoute', () => {
 
     const [config, handler] = router.get.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/_getAll"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [
@@ -63,7 +63,7 @@ describe('getAllActionRoute', () => {
 
     const [config, handler] = router.get.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/_getAll"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [
@@ -94,7 +94,7 @@ describe('getAllActionRoute', () => {
 
     const [config, handler] = router.get.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/_getAll"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [

diff --git a/x-pack/plugins/actions/server/routes/get_all.ts b/x-pack/plugins/actions/server/routes/get_all.ts
@@ -17,7 +17,7 @@ import { BASE_ACTION_API_PATH } from '../../common';
 export const getAllActionRoute = (router: IRouter, licenseState: ILicenseState) => {
   router.get(
     {
-      path: `${BASE_ACTION_API_PATH}/_getAll`,
+      path: `${BASE_ACTION_API_PATH}`,
       validate: {},
       options: {
         tags: ['access:actions-read'],

diff --git a/x-pack/plugins/actions/server/routes/list_action_types.test.ts b/x-pack/plugins/actions/server/routes/list_action_types.test.ts
@@ -28,7 +28,7 @@ describe('listActionTypesRoute', () => {
 
     const [config, handler] = router.get.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/types"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions/list_action_types"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [
@@ -80,7 +80,7 @@ describe('listActionTypesRoute', () => {
 
     const [config, handler] = router.get.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/types"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions/list_action_types"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [
@@ -125,7 +125,7 @@ describe('listActionTypesRoute', () => {
 
     const [config, handler] = router.get.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/types"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions/list_action_types"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [

diff --git a/x-pack/plugins/actions/server/routes/list_action_types.ts b/x-pack/plugins/actions/server/routes/list_action_types.ts
@@ -17,7 +17,7 @@ import { BASE_ACTION_API_PATH } from '../../common';
 export const listActionTypesRoute = (router: IRouter, licenseState: ILicenseState) => {
   router.get(
     {
-      path: `${BASE_ACTION_API_PATH}/types`,
+      path: `${BASE_ACTION_API_PATH}/list_action_types`,
       validate: {},
       options: {
         tags: ['access:actions-read'],

diff --git a/x-pack/plugins/actions/server/routes/update.test.ts b/x-pack/plugins/actions/server/routes/update.test.ts
@@ -27,7 +27,7 @@ describe('updateActionRoute', () => {
 
     const [config, handler] = router.put.mock.calls[0];
 
-    expect(config.path).toMatchInlineSnapshot(`"/api/action/{id}"`);
+    expect(config.path).toMatchInlineSnapshot(`"/api/actions/action/{id}"`);
     expect(config.options).toMatchInlineSnapshot(`
       Object {
         "tags": Array [

diff --git a/x-pack/plugins/actions/server/routes/update.ts b/x-pack/plugins/actions/server/routes/update.ts
@@ -28,7 +28,7 @@ const bodySchema = schema.object({
 export const updateActionRoute = (router: IRouter, licenseState: ILicenseState) => {
   router.put(
     {
-      path: `${BASE_ACTION_API_PATH}/{id}`,
+      path: `${BASE_ACTION_API_PATH}/action/{id}`,
       validate: {
         body: bodySchema,
         params: paramSchema,

diff --git a/x-pack/plugins/case/common/constants.ts b/x-pack/plugins/case/common/constants.ts
@@ -25,7 +25,7 @@ export const CASE_USER_ACTIONS_URL = `${CASE_DETAILS_URL}/user_actions`;
  * Action routes
  */
 
-export const ACTION_URL = '/api/action';
-export const ACTION_TYPES_URL = '/api/action/types';
+export const ACTION_URL = '/api/actions';
+export const ACTION_TYPES_URL = '/api/actions/list_action_types';
 
 export const SUPPORTED_CONNECTORS = ['.servicenow', '.jira'];
diff --git a/x-pack/plugins/monitoring/public/components/alerts/configuration/configuration.tsx b/x-pack/plugins/monitoring/public/components/alerts/configuration/configuration.tsx
@@ -61,7 +61,7 @@ export const AlertsConfiguration: React.FC<AlertsConfigurationProps> = (
   async function fetchEmailActions() {
     const kibanaActions = await Legacy.shims.kfetch({
       method: 'GET',
-      pathname: `/api/action/_getAll`,
+      pathname: `/api/actions`,
     });
 
     const actions = kibanaActions.data.filter(

diff --git a/x-pack/plugins/monitoring/public/components/alerts/configuration/step1.test.tsx b/x-pack/plugins/monitoring/public/components/alerts/configuration/step1.test.tsx
@@ -135,7 +135,7 @@ describe('Step1', () => {
 
       expect(kfetch).toHaveBeenCalledWith({
         method: 'POST',
-        pathname: `/api/action`,
+        pathname: `/api/actions/action`,
         body: JSON.stringify({
           name: 'Email action for Stack Monitoring alerts',
           actionTypeId: ALERT_ACTION_TYPE_EMAIL,
@@ -193,7 +193,7 @@ describe('Step1', () => {
 
       expect(kfetch).toHaveBeenCalledWith({
         method: 'PUT',
-        pathname: `/api/action/${emailActions[0].id}`,
+        pathname: `/api/actions/action/${emailActions[0].id}`,
         body: JSON.stringify({
           name: emailActions[0].name,
           config: omit(data, ['user', 'password']),
@@ -210,7 +210,7 @@ describe('Step1', () => {
           Legacy: {
             shims: {
               kfetch: jest.fn().mockImplementation((arg) => {
-                if (arg.pathname === '/api/action/1/_execute') {
+                if (arg.pathname === '/api/actions/action/1/_execute') {
                   return { status: 'ok' };
                 }
                 return {};
@@ -236,7 +236,7 @@ describe('Step1', () => {
           Legacy: {
             shims: {
               kfetch: (arg: any) => {
-                if (arg.pathname === '/api/action/1/_execute') {
+                if (arg.pathname === '/api/actions/action/1/_execute') {
                   return { status: 'ok' };
                 }
                 return {};
@@ -260,7 +260,7 @@ describe('Step1', () => {
           Legacy: {
             shims: {
               kfetch: (arg: any) => {
-                if (arg.pathname === '/api/action/1/_execute') {
+                if (arg.pathname === '/api/actions/action/1/_execute') {
                   return { message: 'Very detailed error message' };
                 }
                 return {};
@@ -320,7 +320,7 @@ describe('Step1', () => {
 
       expect(kfetch).toHaveBeenCalledWith({
         method: 'DELETE',
-        pathname: `/api/action/${emailActions[0].id}`,
+        pathname: `/api/actions/action/${emailActions[0].id}`,
       });
 
       expect(customProps.setSelectedEmailActionId).toHaveBeenCalledWith('');

diff --git a/x-pack/plugins/monitoring/public/components/alerts/configuration/step1.tsx b/x-pack/plugins/monitoring/public/components/alerts/configuration/step1.tsx
@@ -44,7 +44,7 @@ export const Step1: React.FC<GetStep1Props> = (props: GetStep1Props) => {
     if (props.editAction) {
       await Legacy.shims.kfetch({
         method: 'PUT',
-        pathname: `${BASE_ACTION_API_PATH}/${props.editAction.id}`,
+        pathname: `${BASE_ACTION_API_PATH}/action/${props.editAction.id}`,
         body: JSON.stringify({
           name: props.editAction.name,
           config: omit(data, ['user', 'password']),
@@ -55,7 +55,7 @@ export const Step1: React.FC<GetStep1Props> = (props: GetStep1Props) => {
     } else {
       await Legacy.shims.kfetch({
         method: 'POST',
-        pathname: BASE_ACTION_API_PATH,
+        pathname: `${BASE_ACTION_API_PATH}/action`,
         body: JSON.stringify({
           name: i18n.translate('xpack.monitoring.alerts.configuration.emailAction.name', {
             defaultMessage: 'Email action for Stack Monitoring alerts',
@@ -75,7 +75,7 @@ export const Step1: React.FC<GetStep1Props> = (props: GetStep1Props) => {
 
     await Legacy.shims.kfetch({
       method: 'DELETE',
-      pathname: `${BASE_ACTION_API_PATH}/${id}`,
+      pathname: `${BASE_ACTION_API_PATH}/action/${id}`,
     });
 
     if (props.editAction && props.editAction.id === id) {
@@ -101,7 +101,7 @@ export const Step1: React.FC<GetStep1Props> = (props: GetStep1Props) => {
 
     const result = await Legacy.shims.kfetch({
       method: 'POST',
-      pathname: `${BASE_ACTION_API_PATH}/${props.selectedEmailActionId}/_execute`,
+      pathname: `${BASE_ACTION_API_PATH}/action/${props.selectedEmailActionId}/_execute`,
       body: JSON.stringify({ params }),
     });
     if (result.status === 'ok') {

diff --git a/x-pack/plugins/siem/cypress/integration/cases_connectors.spec.ts b/x-pack/plugins/siem/cypress/integration/cases_connectors.spec.ts
@@ -21,7 +21,7 @@ import { CASES } from '../urls/navigation';
 describe.skip('Cases connectors', () => {
   before(() => {
     cy.server();
-    cy.route('POST', '**/api/action').as('createConnector');
+    cy.route('POST', '**/api/actions/action').as('createConnector');
     cy.route('POST', '**/api/cases/configure').as('saveConnector');
   });
 

diff --git a/x-pack/plugins/siem/public/cases/containers/api.test.tsx b/x-pack/plugins/siem/public/cases/containers/api.test.tsx
@@ -88,7 +88,7 @@ describe('Case Configuration API', () => {
     });
     test('check url, method, signal', async () => {
       await getActionLicense(abortCtrl.signal);
-      expect(fetchMock).toHaveBeenCalledWith(`/api/action/types`, {
+      expect(fetchMock).toHaveBeenCalledWith(`/api/actions/list_action_types`, {
         method: 'GET',
         signal: abortCtrl.signal,
       });
@@ -416,7 +416,7 @@ describe('Case Configuration API', () => {
     const connectorId = 'connectorId';
     test('check url, method, signal', async () => {
       await pushToService(connectorId, casePushParams, abortCtrl.signal);
-      expect(fetchMock).toHaveBeenCalledWith(`/api/action/${connectorId}/_execute`, {
+      expect(fetchMock).toHaveBeenCalledWith(`/api/actions/action/${connectorId}/_execute`, {
         method: 'POST',
         body: JSON.stringify({
           params: { subAction: 'pushToService', subActionParams: casePushParams },

diff --git a/x-pack/plugins/siem/public/cases/containers/api.ts b/x-pack/plugins/siem/public/cases/containers/api.ts
@@ -242,7 +242,7 @@ export const pushToService = async (
   signal: AbortSignal
 ): Promise<ServiceConnectorCaseResponse> => {
   const response = await KibanaServices.get().http.fetch<ActionTypeExecutorResult>(
-    `${ACTION_URL}/${connectorId}/_execute`,
+    `${ACTION_URL}/action/${connectorId}/_execute`,
     {
       method: 'POST',
       body: JSON.stringify({

diff --git a/x-pack/plugins/siem/server/lib/detection_engine/scripts/get_action_instances.sh b/x-pack/plugins/siem/server/lib/detection_engine/scripts/get_action_instances.sh
@@ -13,5 +13,5 @@ set -e
 # https://github.com/elastic/kibana/blob/master/x-pack/plugins/actions/README.md#get-apiaction_find-find-actions
 curl -s -k \
   -u ${ELASTICSEARCH_USERNAME}:${ELASTICSEARCH_PASSWORD} \
-  -X GET ${KIBANA_URL}${SPACE_URL}/api/action/_getAll \
+  -X GET ${KIBANA_URL}${SPACE_URL}/api/actions \
   | jq .
diff --git a/x-pack/plugins/siem/server/lib/detection_engine/scripts/get_action_types.sh b/x-pack/plugins/siem/server/lib/detection_engine/scripts/get_action_types.sh
@@ -13,5 +13,5 @@ set -e
 # https://github.com/elastic/kibana/blob/master/x-pack/plugins/actions/README.md
 curl -s -k \
   -u ${ELASTICSEARCH_USERNAME}:${ELASTICSEARCH_PASSWORD} \
-  -X GET ${KIBANA_URL}${SPACE_URL}/api/action/types \
+  -X GET ${KIBANA_URL}${SPACE_URL}/api/actions/list_action_types \
   | jq .
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@

		export * from './types';

		export const BASE_ACTION_API_PATH = '/api/action';
		export const BASE_ACTION_API_PATH = '/api/actions';