sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-15 23:16:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

for curl fix next line issue

Browse Source
This commit is contained in:
Pascal Fischer
2023-05-08 18:51:25 +02:00
parent 4c51e12888
commit 4d189d2e39
12 changed files with 49 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
generator/templates/ApiTemplate.ts
View File

@@ -63,12 +63,12 @@ export const title = '<%- tag %>'
<CodeGroup title="Request" tag="<%- operation.operation.toUpperCase() %>" label="<%- operation.path %>">
\`\`\`bash {{ title: 'cURL' }}
<% if(true){ -%>
curl -X <%- operation.operation.toUpperCase() %> <%- operation.fullPath %> \\
-H "Authorization: Token <TOKEN>" \\<% }; -%>
curl -X <%- operation.operation.toUpperCase() %> <%- operation.fullPath %> \\<% }; -%>
<% if(operation.responseList[0].content && operation.responseList[0].content['application/json']){ %>
-H 'Accept: application/json' \\<% }; -%>
<% if(operation.requestBody?.content && operation.requestBody?.content['application/json']){ %>
-H 'Content-Type: application/json' \\\n--data-raw '<%- JSON.stringify(components.get(operation.requestBody?.content['application/json'].schema.$ref?.split('/').pop())?.example, null, 2) -%>'<% }; %>
-H 'Content-Type: application/json' \\<% }; %>
-H "Authorization: Token <TOKEN>" <% if(operation.requestBody?.content && operation.requestBody?.content['application/json']){ %>\\\n--data-raw '<%- JSON.stringify(components.get(operation.requestBody?.content['application/json'].schema.$ref?.split('/').pop())?.example, null, 2) -%>'<% }; %>
\`\`\`
\`\`\`js

4
src/pages/accounts.mdx
View File

@@ -17,8 +17,8 @@ export const title = 'Accounts'
<CodeGroup title="Request" tag="GET" label="/api/accounts">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/accounts \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -235,9 +235,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/accounts/{accountId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/accounts/{accountId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200

14
src/pages/dns.mdx
View File

@@ -17,8 +17,8 @@ export const title = 'DNS'
<CodeGroup title="Request" tag="GET" label="/api/dns/nameservers">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/dns/nameservers \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -296,9 +296,9 @@ echo $response;
<CodeGroup title="Request" tag="POST" label="/api/dns/nameservers">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/dns/nameservers \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "Google DNS",
"description": "Google DNS servers",
@@ -657,8 +657,8 @@ echo $response;
<CodeGroup title="Request" tag="GET" label="/api/dns/nameservers/{nsgroupId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/dns/nameservers/{nsgroupId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -940,9 +940,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/dns/nameservers/{nsgroupId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/dns/nameservers/{nsgroupId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "Google DNS",
"description": "Google DNS servers",
@@ -1301,7 +1301,7 @@ echo $response;
<CodeGroup title="Request" tag="DELETE" label="/api/dns/nameservers/{nsgroupId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/dns/nameservers/{nsgroupId} \
-H "Authorization: Token <TOKEN>" \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -1459,8 +1459,8 @@ echo $response;
<CodeGroup title="Request" tag="GET" label="/api/dns/settings">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/dns/settings \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -1658,9 +1658,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/dns/settings">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/dns/settings \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"disabled_management_groups": [
"ch8i4ug6lnn4g9hqv7m0"

2
src/pages/events.mdx
View File

@@ -17,8 +17,8 @@ export const title = 'Events'
<CodeGroup title="Request" tag="GET" label="/api/events">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/events \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js

10
src/pages/groups.mdx
View File

@@ -17,8 +17,8 @@ export const title = 'Groups'
<CodeGroup title="Request" tag="GET" label="/api/groups">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/groups \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -235,9 +235,9 @@ echo $response;
<CodeGroup title="Request" tag="POST" label="/api/groups">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/groups \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "devs",
"peers": [
@@ -487,8 +487,8 @@ echo $response;
<CodeGroup title="Request" tag="GET" label="/api/groups/{groupId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/groups/{groupId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -709,9 +709,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/groups/{groupId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/groups/{groupId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "devs",
"peers": [
@@ -961,7 +961,7 @@ echo $response;
<CodeGroup title="Request" tag="DELETE" label="/api/groups/{groupId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/groups/{groupId} \
-H "Authorization: Token <TOKEN>" \
-H "Authorization: Token <TOKEN>"
```
```js

8
src/pages/peers.mdx
View File

@@ -17,8 +17,8 @@ export const title = 'Peers'
<CodeGroup title="Request" tag="GET" label="/api/peers">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/peers \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -251,8 +251,8 @@ echo $response;
<CodeGroup title="Request" tag="GET" label="/api/peers/{peerId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/peers/{peerId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -506,9 +506,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/peers/{peerId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/peers/{peerId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "stage-host-1",
"ssh_enabled": true,
@@ -777,7 +777,7 @@ echo $response;
<CodeGroup title="Request" tag="DELETE" label="/api/peers/{peerId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/peers/{peerId} \
-H "Authorization: Token <TOKEN>" \
-H "Authorization: Token <TOKEN>"
```
```js

10
src/pages/policies.mdx
View File

@@ -17,8 +17,8 @@ export const title = 'Policies'
<CodeGroup title="Request" tag="GET" label="/api/policies">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/policies \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -294,9 +294,9 @@ echo $response;
<CodeGroup title="Request" tag="POST" label="/api/policies">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/policies \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "ch8i4ug6lnn4g9hqv7mg",
"description": "This is a default policy that allows connections between all the resources",
@@ -741,8 +741,8 @@ echo $response;
<CodeGroup title="Request" tag="GET" label="/api/policies/{policyId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/policies/{policyId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -1022,9 +1022,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/policies/{policyId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/policies/{policyId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "ch8i4ug6lnn4g9hqv7mg",
"description": "This is a default policy that allows connections between all the resources",
@@ -1473,7 +1473,7 @@ echo $response;
<CodeGroup title="Request" tag="DELETE" label="/api/policies/{policyId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/policies/{policyId} \
-H "Authorization: Token <TOKEN>" \
-H "Authorization: Token <TOKEN>"
```
```js

10
src/pages/routes.mdx
View File

@@ -17,8 +17,8 @@ export const title = 'Routes'
<CodeGroup title="Request" tag="GET" label="/api/routes">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/routes \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -291,9 +291,9 @@ echo $response;
<CodeGroup title="Request" tag="POST" label="/api/routes">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/routes \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"description": "My first route",
"network_id": "Route 1",
@@ -591,8 +591,8 @@ echo $response;
<CodeGroup title="Request" tag="GET" label="/api/routes/{routeId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/routes/{routeId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -869,9 +869,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/routes/{routeId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/routes/{routeId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"description": "My first route",
"network_id": "Route 1",
@@ -1169,7 +1169,7 @@ echo $response;
<CodeGroup title="Request" tag="DELETE" label="/api/routes/{routeId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/routes/{routeId} \
-H "Authorization: Token <TOKEN>" \
-H "Authorization: Token <TOKEN>"
```
```js

10
src/pages/rules.mdx
View File

@@ -17,8 +17,8 @@ export const title = 'Rules'
<CodeGroup title="Request" tag="GET" label="/api/rules">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/rules \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -283,9 +283,9 @@ echo $response;
<CodeGroup title="Request" tag="POST" label="/api/rules">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/rules \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
@@ -593,8 +593,8 @@ echo $response;
<CodeGroup title="Request" tag="GET" label="/api/rules/{ruleId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/rules/{ruleId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -863,9 +863,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/rules/{ruleId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/rules/{ruleId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
@@ -1177,7 +1177,7 @@ echo $response;
<CodeGroup title="Request" tag="DELETE" label="/api/rules/{ruleId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/rules/{ruleId} \
-H "Authorization: Token <TOKEN>" \
-H "Authorization: Token <TOKEN>"
```
```js

8
src/pages/setup-keys.mdx
View File

@@ -17,8 +17,8 @@ export const title = 'Setup Keys'
<CodeGroup title="Request" tag="GET" label="/api/setup-keys">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/setup-keys \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -275,9 +275,9 @@ echo $response;
<CodeGroup title="Request" tag="POST" label="/api/setup-keys">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/setup-keys \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "Default key",
"type": "reusable",
@@ -567,8 +567,8 @@ echo $response;
<CodeGroup title="Request" tag="GET" label="/api/setup-keys/{keyId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/setup-keys/{keyId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -829,9 +829,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/setup-keys/{keyId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/setup-keys/{keyId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "Default key",
"type": "reusable",

8
src/pages/tokens.mdx
View File

@@ -25,8 +25,8 @@ export const title = 'Tokens'
<CodeGroup title="Request" tag="GET" label="/api/users/{userId}/tokens">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/users/{userId}/tokens \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -249,9 +249,9 @@ echo $response;
<CodeGroup title="Request" tag="POST" label="/api/users/{userId}/tokens">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/users/{userId}/tokens \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"name": "My first token",
"expires_in": 30
@@ -491,8 +491,8 @@ echo $response;
<CodeGroup title="Request" tag="GET" label="/api/users/{userId}/tokens/{tokenId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/users/{userId}/tokens/{tokenId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -693,7 +693,7 @@ echo $response;
<CodeGroup title="Request" tag="DELETE" label="/api/users/{userId}/tokens/{tokenId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/users/{userId}/tokens/{tokenId} \
-H "Authorization: Token <TOKEN>" \
-H "Authorization: Token <TOKEN>"
```
```js

8
src/pages/users.mdx
View File

@@ -25,8 +25,8 @@ export const title = 'Users'
<CodeGroup title="Request" tag="GET" label="/api/users">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/users \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H "Authorization: Token <TOKEN>"
```
```js
@@ -266,9 +266,9 @@ echo $response;
<CodeGroup title="Request" tag="POST" label="/api/users">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/users \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"email": "demo@netbird.io",
"name": "Tom Schulz",
@@ -559,9 +559,9 @@ echo $response;
<CodeGroup title="Request" tag="PUT" label="/api/users/{userId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/users/{userId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H "Authorization: Token <TOKEN>" \
--data-raw '{
"role": "admin",
"auto_groups": [
@@ -813,7 +813,7 @@ echo $response;
<CodeGroup title="Request" tag="DELETE" label="/api/users/{userId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/users/{userId} \
-H "Authorization: Token <TOKEN>" \
-H "Authorization: Token <TOKEN>"
```
```js