extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2025-06-20 01:38:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Soft deprecate Rules API (#1454)

Browse Source
This commit is contained in:
Yury Gargay 2024-01-10 13:55:11 +01:00 committed by GitHub
parent c61cb00f40
commit 5311ce4e4a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
management/server/http/api/openapi.yml
View File

@ -1822,8 +1822,9 @@ paths:
/api/rules: /api/rules:
get: get:
summary: List all Rules 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 ] tags: [ Rules ]
deprecated: true
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
- TokenAuth: [ ] - TokenAuth: [ ]
@ -1846,7 +1847,8 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
summary: Create a Rule summary: Create a Rule
description: Creates a rule description: Creates a rule. This will be deprecated in favour of `/api/policies`.
deprecated: true
tags: [ Rules ] tags: [ Rules ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
@ -1867,7 +1869,8 @@ paths:
/api/rules/{ruleId}: /api/rules/{ruleId}:
get: get:
summary: Retrieve a Rule 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}`.
deprecated: true
tags: [ Rules ] tags: [ Rules ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
@ -1896,7 +1899,8 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
put: put:
summary: Update a Rule summary: Update a Rule
description: Update/Replace a rule description: Update/Replace a rule. This will be deprecated in favour of `/api/policies/{policyID}`.
deprecated: true
tags: [ Rules ] tags: [ Rules ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
@ -1931,7 +1935,8 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
delete: delete:
summary: Delete a Rule summary: Delete a Rule
description: Delete a rule description: Delete a rule. This will be deprecated in favour of `/api/policies/{policyID}`.
deprecated: true
tags: [ Rules ] tags: [ Rules ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]