From 910739c4a3049c0c2a5585e3e042a06817d71e87 Mon Sep 17 00:00:00 2001 From: Yury Gargay Date: Wed, 10 Jan 2024 10:58:17 +0100 Subject: [PATCH 1/2] Soft deprecate Rules API The Policies API should be the way to go. --- management/server/http/api/openapi.yml | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/management/server/http/api/openapi.yml b/management/server/http/api/openapi.yml index 1a049a0cff5..a78f13ed011 100644 --- a/management/server/http/api/openapi.yml +++ b/management/server/http/api/openapi.yml @@ -1822,8 +1822,9 @@ paths: /api/rules: get: summary: List all Rules - description: Returns a list of all rules + description: Returns a list of all rules. This will be deprecated in favour of `/api/policies`. tags: [ Rules ] + depricated: true security: - BearerAuth: [ ] - TokenAuth: [ ] @@ -1846,7 +1847,8 @@ paths: "$ref": "#/components/responses/internal_error" post: summary: Create a Rule - description: Creates a rule + description: Creates a rule. This will be deprecated in favour of `/api/policies`. + depricated: true tags: [ Rules ] security: - BearerAuth: [ ] @@ -1867,7 +1869,8 @@ paths: /api/rules/{ruleId}: get: summary: Retrieve a Rule - description: Get information about a rules + description: Get information about a rules. This will be deprecated in favour of `/api/policies/{policyID}`. + depricated: true tags: [ Rules ] security: - BearerAuth: [ ] @@ -1896,7 +1899,8 @@ paths: "$ref": "#/components/responses/internal_error" put: summary: Update a Rule - description: Update/Replace a rule + description: Update/Replace a rule. This will be deprecated in favour of `/api/policies/{policyID}`. + depricated: true tags: [ Rules ] security: - BearerAuth: [ ] @@ -1931,7 +1935,8 @@ paths: "$ref": "#/components/responses/internal_error" delete: summary: Delete a Rule - description: Delete a rule + description: Delete a rule. This will be deprecated in favour of `/api/policies/{policyID}`. + depricated: true tags: [ Rules ] security: - BearerAuth: [ ] From b921936734c5a58ac49aae164b81f4ac6ec52c69 Mon Sep 17 00:00:00 2001 From: Yury Gargay Date: Wed, 10 Jan 2024 11:10:22 +0100 Subject: [PATCH 2/2] Fix typo --- management/server/http/api/openapi.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/management/server/http/api/openapi.yml b/management/server/http/api/openapi.yml index a78f13ed011..cd6b7cbfb0f 100644 --- a/management/server/http/api/openapi.yml +++ b/management/server/http/api/openapi.yml @@ -1824,7 +1824,7 @@ paths: summary: List all Rules description: Returns a list of all rules. This will be deprecated in favour of `/api/policies`. tags: [ Rules ] - depricated: true + deprecated: true security: - BearerAuth: [ ] - TokenAuth: [ ] @@ -1848,7 +1848,7 @@ paths: post: summary: Create a Rule description: Creates a rule. This will be deprecated in favour of `/api/policies`. - depricated: true + deprecated: true tags: [ Rules ] security: - BearerAuth: [ ] @@ -1870,7 +1870,7 @@ paths: get: summary: Retrieve a Rule description: Get information about a rules. This will be deprecated in favour of `/api/policies/{policyID}`. - depricated: true + deprecated: true tags: [ Rules ] security: - BearerAuth: [ ] @@ -1900,7 +1900,7 @@ paths: put: summary: Update a Rule description: Update/Replace a rule. This will be deprecated in favour of `/api/policies/{policyID}`. - depricated: true + deprecated: true tags: [ Rules ] security: - BearerAuth: [ ] @@ -1936,7 +1936,7 @@ paths: delete: summary: Delete a Rule description: Delete a rule. This will be deprecated in favour of `/api/policies/{policyID}`. - depricated: true + deprecated: true tags: [ Rules ] security: - BearerAuth: [ ]