extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2024-12-24 15:48:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix summary

Browse Source
This commit is contained in:
Pascal Fischer 2023-06-02 01:32:48 +02:00
parent 75fbaf811b
commit 2dcfa1efa3
1 changed files with 42 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -941,7 +941,7 @@ security:
paths: paths:
/api/accounts: /api/accounts:
get: get:
summary: List all accounts summary: List all Accounts
description: Returns a list of accounts of a user. Always returns a list of one account. description: Returns a list of accounts of a user. Always returns a list of one account.
tags: [ Accounts ] tags: [ Accounts ]
security: security:
@ -966,7 +966,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/accounts/{accountId}: /api/accounts/{accountId}:
put: put:
summary: Update an account summary: Update an Account
description: Update information about an account description: Update information about an account
tags: [ Accounts ] tags: [ Accounts ]
security: security:
@ -1002,7 +1002,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/users: /api/users:
get: get:
summary: List all users summary: List all Users
description: Returns a list of all users description: Returns a list of all users
tags: [ Users ] tags: [ Users ]
security: security:
@ -1032,7 +1032,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
summary: Create a user summary: Create a User
description: Creates a new service user or sends an invite to a regular user description: Creates a new service user or sends an invite to a regular user
tags: [ Users ] tags: [ Users ]
security: security:
@ -1061,7 +1061,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/users/{userId}: /api/users/{userId}:
put: put:
summary: Update a user summary: Update a User
description: Update information about a User description: Update information about a User
tags: [ Users ] tags: [ Users ]
security: security:
@ -1096,7 +1096,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
delete: delete:
summary: Delete a user summary: Delete a User
description: Delete a user description: Delete a user
tags: [ Users ] tags: [ Users ]
security: security:
@ -1123,7 +1123,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/users/{userId}/tokens: /api/users/{userId}/tokens:
get: get:
summary: List all tokens summary: List all Tokens
description: Returns a list of all tokens for a user description: Returns a list of all tokens for a user
tags: [ Tokens ] tags: [ Tokens ]
security: security:
@ -1154,7 +1154,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
summary: Create a token summary: Create a Token
description: Create a new token for a user description: Create a new token for a user
tags: [ Tokens ] tags: [ Tokens ]
security: security:
@ -1190,7 +1190,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/users/{userId}/tokens/{tokenId}: /api/users/{userId}/tokens/{tokenId}:
get: get:
summary: Retrieve a token summary: Retrieve a Token
description: Returns a specific token for a user description: Returns a specific token for a user
tags: [ Tokens ] tags: [ Tokens ]
security: security:
@ -1225,7 +1225,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
delete: delete:
summary: Delete a token summary: Delete a Token
description: Delete a token for a user description: Delete a token for a user
tags: [ Tokens ] tags: [ Tokens ]
security: security:
@ -1258,7 +1258,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/peers: /api/peers:
get: get:
summary: List all peers summary: List all Peers
description: Returns a list of all peers description: Returns a list of all peers
tags: [ Peers ] tags: [ Peers ]
security: security:
@ -1283,7 +1283,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/peers/{peerId}: /api/peers/{peerId}:
get: get:
summary: Retrieve a peer summary: Retrieve a Peer
description: Get information about a peer description: Get information about a peer
tags: [ Peers ] tags: [ Peers ]
security: security:
@ -1312,7 +1312,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
put: put:
summary: Update a peer summary: Update a Peer
description: Update information about a peer description: Update information about a peer
tags: [ Peers ] tags: [ Peers ]
security: security:
@ -1347,7 +1347,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
delete: delete:
summary: Delete a peer summary: Delete a Peer
description: Delete a peer description: Delete a peer
tags: [ Peers ] tags: [ Peers ]
security: security:
@ -1374,7 +1374,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/setup-keys: /api/setup-keys:
get: get:
summary: List all setup keys summary: List all Setup Keys
description: Returns a list of all Setup Keys description: Returns a list of all Setup Keys
tags: [ Setup Keys ] tags: [ Setup Keys ]
security: security:
@ -1398,7 +1398,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
summary: Create a setup key summary: Create a Setup Key
description: Creates a setup key description: Creates a setup key
tags: [ Setup Keys ] tags: [ Setup Keys ]
security: security:
@ -1427,7 +1427,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/setup-keys/{keyId}: /api/setup-keys/{keyId}:
get: get:
summary: Retrieve a setup key summary: Retrieve a Setup Key
description: Get information about a setup key description: Get information about a setup key
tags: [ Setup Keys ] tags: [ Setup Keys ]
security: security:
@ -1456,7 +1456,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
put: put:
summary: Update a setup key summary: Update a Setup Key
description: Update information about a setup key description: Update information about a setup key
tags: [ Setup Keys ] tags: [ Setup Keys ]
security: security:
@ -1492,7 +1492,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/groups: /api/groups:
get: get:
summary: List all groups summary: List all Groups
description: Returns a list of all groups description: Returns a list of all groups
tags: [ Groups ] tags: [ Groups ]
security: security:
@ -1516,7 +1516,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
summary: Create a group summary: Create a Group
description: Creates a group description: Creates a group
tags: [ Groups ] tags: [ Groups ]
security: security:
@ -1545,7 +1545,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/groups/{groupId}: /api/groups/{groupId}:
get: get:
summary: Retrieve a group summary: Retrieve a Group
description: Get information about a group description: Get information about a group
tags: [ Groups ] tags: [ Groups ]
security: security:
@ -1574,7 +1574,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
put: put:
summary: Update a group summary: Update a Group
description: Update/Replace a group description: Update/Replace a group
tags: [ Groups ] tags: [ Groups ]
security: security:
@ -1636,7 +1636,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/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
tags: [ Rules ] tags: [ Rules ]
security: security:
@ -1660,7 +1660,7 @@ paths:
'500': '500':
"$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
tags: [ Rules ] tags: [ Rules ]
security: security:
@ -1681,7 +1681,7 @@ paths:
$ref: '#/components/schemas/Rule' $ref: '#/components/schemas/Rule'
/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
tags: [ Rules ] tags: [ Rules ]
security: security:
@ -1710,7 +1710,7 @@ paths:
'500': '500':
"$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
tags: [ Rules ] tags: [ Rules ]
security: security:
@ -1745,7 +1745,7 @@ paths:
'500': '500':
"$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
tags: [ Rules ] tags: [ Rules ]
security: security:
@ -1772,7 +1772,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/policies: /api/policies:
get: get:
summary: List all policies summary: List all Policies
description: Returns a list of all policies description: Returns a list of all policies
tags: [ Policies ] tags: [ Policies ]
security: security:
@ -1796,7 +1796,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
summary: Create a policy summary: Create a Policy
description: Creates a policy description: Creates a policy
tags: [ Policies ] tags: [ Policies ]
security: security:
@ -1817,7 +1817,7 @@ paths:
$ref: '#/components/schemas/Policy' $ref: '#/components/schemas/Policy'
/api/policies/{policyId}: /api/policies/{policyId}:
get: get:
summary: Retrieve a policy summary: Retrieve a Policy
description: Get information about a Policies description: Get information about a Policies
tags: [ Policies ] tags: [ Policies ]
security: security:
@ -1846,7 +1846,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
put: put:
summary: Update a policy summary: Update a Policy
description: Update/Replace a Policy description: Update/Replace a Policy
tags: [ Policies ] tags: [ Policies ]
security: security:
@ -1908,7 +1908,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/routes: /api/routes:
get: get:
summary: List all routes summary: List all Routes
description: Returns a list of all routes description: Returns a list of all routes
tags: [ Routes ] tags: [ Routes ]
security: security:
@ -1932,7 +1932,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
summary: Create a route summary: Create a Route
description: Creates a Route description: Creates a Route
tags: [ Routes ] tags: [ Routes ]
security: security:
@ -1962,7 +1962,7 @@ paths:
/api/routes/{routeId}: /api/routes/{routeId}:
get: get:
summary: Retrieve a route summary: Retrieve a Route
description: Get information about a Routes description: Get information about a Routes
tags: [ Routes ] tags: [ Routes ]
security: security:
@ -1991,7 +1991,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
put: put:
summary: Update a route summary: Update a Route
description: Update/Replace a Route description: Update/Replace a Route
tags: [ Routes ] tags: [ Routes ]
security: security:
@ -2053,7 +2053,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/dns/nameservers: /api/dns/nameservers:
get: get:
summary: List all nameserver groups summary: List all Nameserver Groups
description: Returns a list of all Nameserver Groups description: Returns a list of all Nameserver Groups
tags: [ DNS ] tags: [ DNS ]
security: security:
@ -2077,7 +2077,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
summary: Create a nameserver group summary: Create a Nameserver Group
description: Creates a Nameserver Group description: Creates a Nameserver Group
tags: [ DNS ] tags: [ DNS ]
security: security:
@ -2107,7 +2107,7 @@ paths:
/api/dns/nameservers/{nsgroupId}: /api/dns/nameservers/{nsgroupId}:
get: get:
summary: Retrieve a nameserver group summary: Retrieve a Nameserver Group
description: Get information about a Nameserver Groups description: Get information about a Nameserver Groups
tags: [ DNS ] tags: [ DNS ]
security: security:
@ -2136,7 +2136,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
put: put:
summary: Update a nameserver group summary: Update a Nameserver Group
description: Update/Replace a Nameserver Group description: Update/Replace a Nameserver Group
tags: [ DNS ] tags: [ DNS ]
security: security:
@ -2171,7 +2171,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
delete: delete:
summary: Delete a nameserver group summary: Delete a Nameserver Group
description: Delete a Nameserver Group description: Delete a Nameserver Group
tags: [ DNS ] tags: [ DNS ]
security: security:
@ -2222,7 +2222,7 @@ paths:
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
put: put:
summary: Update DNS settings summary: Update DNS Settings
description: Updates a DNS settings object description: Updates a DNS settings object
tags: [ DNS ] tags: [ DNS ]
security: security:
@ -2251,7 +2251,7 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/events: /api/events:
get: get:
summary: List all events summary: List all Events
description: Returns a list of all events description: Returns a list of all events
tags: [ Events ] tags: [ Events ]
security: security: