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

Update API docs (#84)

Browse Source 
* Update API docs

* Update API pages with v0.23.0

---------

Co-authored-by: netbirddev <dev@netbird.io>
This commit is contained in:
Maycon Santos
2023-09-06 11:55:51 +02:00
committed by GitHub
parent d2d0f836c1
commit 0d50068de9
3 changed files with 64 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -24,7 +24,6 @@ $ npm run dev
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
## Contributing to the docs ## Contributing to the docs
You can click the **Fork** button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a _fork_. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it. You can click the **Fork** button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a _fork_. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.

80
src/pages/ipa/resources/setup-keys.mdx
View File

@@ -177,7 +177,8 @@ echo $response;
"devs" "devs"
], ],
"updated_at": "2023-05-05T09:00:35.477782Z", "updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
} }
] ]
``` ```
@@ -198,7 +199,8 @@ echo $response;
"string" "string"
], ],
"updated_at": "string", "updated_at": "string",
"usage_limit": "integer" "usage_limit": "integer",
"ephemeral": "boolean"
} }
] ]
``` ```
@@ -267,6 +269,13 @@ echo $response;
> >
A number of times this key can be used. The value of 0 indicates the unlimited usage. A number of times this key can be used. The value of 0 indicates the unlimited usage.
</Property>
<Property name="ephemeral" type="boolean" required={false}
>
Indicate that the peer will be ephemeral or not
</Property> </Property>
</Properties> </Properties>
</Col> </Col>
@@ -286,7 +295,8 @@ curl -X POST https://api.netbird.io/api/setup-keys \
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}' }'
``` ```
@@ -300,7 +310,8 @@ let data = JSON.stringify({
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}); });
let config = { let config = {
method: 'post', method: 'post',
@@ -336,7 +347,8 @@ payload = json.dumps({
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}) })
headers: { headers: {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
@@ -372,7 +384,8 @@ func main() {
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}`) }`)
client := &http.Client { client := &http.Client {
} }
@@ -426,7 +439,8 @@ request.body = JSON.dump({
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}) })
response = https.request(request) response = https.request(request)
puts response.read_body puts response.read_body
@@ -444,7 +458,8 @@ RequestBody body = RequestBody.create(mediaType, '{
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}'); }');
Request request = new Request.Builder() Request request = new Request.Builder()
.url("https://api.netbird.io/api/setup-keys") .url("https://api.netbird.io/api/setup-keys")
@@ -478,7 +493,8 @@ curl_setopt_array($curl, array(
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}', }',
CURLOPT_HTTPHEADER => array( CURLOPT_HTTPHEADER => array(
'Content-Type: application/json', 'Content-Type: application/json',
@@ -514,7 +530,8 @@ echo $response;
"devs" "devs"
], ],
"updated_at": "2023-05-05T09:00:35.477782Z", "updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
} }
``` ```
```json {{ title: 'Schema' }} ```json {{ title: 'Schema' }}
@@ -533,7 +550,8 @@ echo $response;
"string" "string"
], ],
"updated_at": "string", "updated_at": "string",
"usage_limit": "integer" "usage_limit": "integer",
"ephemeral": "boolean"
} }
``` ```
</CodeGroup> </CodeGroup>
@@ -730,7 +748,8 @@ echo $response;
"devs" "devs"
], ],
"updated_at": "2023-05-05T09:00:35.477782Z", "updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
} }
``` ```
```json {{ title: 'Schema' }} ```json {{ title: 'Schema' }}
@@ -749,7 +768,8 @@ echo $response;
"string" "string"
], ],
"updated_at": "string", "updated_at": "string",
"usage_limit": "integer" "usage_limit": "integer",
"ephemeral": "boolean"
} }
``` ```
</CodeGroup> </CodeGroup>
@@ -825,6 +845,13 @@ echo $response;
> >
A number of times this key can be used. The value of 0 indicates the unlimited usage. A number of times this key can be used. The value of 0 indicates the unlimited usage.
</Property>
<Property name="ephemeral" type="boolean" required={false}
>
Indicate that the peer will be ephemeral or not
</Property> </Property>
</Properties> </Properties>
</Col> </Col>
@@ -844,7 +871,8 @@ curl -X PUT https://api.netbird.io/api/setup-keys/{keyId} \
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}' }'
``` ```
@@ -858,7 +886,8 @@ let data = JSON.stringify({
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}); });
let config = { let config = {
method: 'put', method: 'put',
@@ -894,7 +923,8 @@ payload = json.dumps({
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}) })
headers: { headers: {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
@@ -930,7 +960,8 @@ func main() {
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}`) }`)
client := &http.Client { client := &http.Client {
} }
@@ -984,7 +1015,8 @@ request.body = JSON.dump({
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}) })
response = https.request(request) response = https.request(request)
puts response.read_body puts response.read_body
@@ -1002,7 +1034,8 @@ RequestBody body = RequestBody.create(mediaType, '{
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}'); }');
Request request = new Request.Builder() Request request = new Request.Builder()
.url("https://api.netbird.io/api/setup-keys/{keyId}") .url("https://api.netbird.io/api/setup-keys/{keyId}")
@@ -1036,7 +1069,8 @@ curl_setopt_array($curl, array(
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
}', }',
CURLOPT_HTTPHEADER => array( CURLOPT_HTTPHEADER => array(
'Content-Type: application/json', 'Content-Type: application/json',
@@ -1072,7 +1106,8 @@ echo $response;
"devs" "devs"
], ],
"updated_at": "2023-05-05T09:00:35.477782Z", "updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0 "usage_limit": 0,
"ephemeral": true
} }
``` ```
```json {{ title: 'Schema' }} ```json {{ title: 'Schema' }}
@@ -1091,7 +1126,8 @@ echo $response;
"string" "string"
], ],
"updated_at": "string", "updated_at": "string",
"usage_limit": "integer" "usage_limit": "integer",
"ephemeral": "boolean"
} }
``` ```
</CodeGroup> </CodeGroup>

6
src/pages/ipa/resources/users.mdx
View File

@@ -176,6 +176,7 @@ echo $response;
"name": "Tom Schulz", "name": "Tom Schulz",
"role": "admin", "role": "admin",
"status": "active", "status": "active",
"last_login": "2023-05-05T09:00:35.477782Z",
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
@@ -193,6 +194,7 @@ echo $response;
"name": "string", "name": "string",
"role": "string", "role": "string",
"status": "string", "status": "string",
"last_login": "string",
"auto_groups": [ "auto_groups": [
"string" "string"
], ],
@@ -487,6 +489,7 @@ echo $response;
"name": "Tom Schulz", "name": "Tom Schulz",
"role": "admin", "role": "admin",
"status": "active", "status": "active",
"last_login": "2023-05-05T09:00:35.477782Z",
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
@@ -502,6 +505,7 @@ echo $response;
"name": "string", "name": "string",
"role": "string", "role": "string",
"status": "string", "status": "string",
"last_login": "string",
"auto_groups": [ "auto_groups": [
"string" "string"
], ],
@@ -775,6 +779,7 @@ echo $response;
"name": "Tom Schulz", "name": "Tom Schulz",
"role": "admin", "role": "admin",
"status": "active", "status": "active",
"last_login": "2023-05-05T09:00:35.477782Z",
"auto_groups": [ "auto_groups": [
"devs" "devs"
], ],
@@ -790,6 +795,7 @@ echo $response;
"name": "string", "name": "string",
"role": "string", "role": "string",
"status": "string", "status": "string",
"last_login": "string",
"auto_groups": [ "auto_groups": [
"string" "string"
], ],