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

Change API parser to handle nested objects (#159)

Browse Source 
* rewrite parser to handle new format and nested objects

* add properties section also to nested properties

* update docs manually
This commit is contained in:
pascal-fischer
2024-02-29 15:24:00 +02:00
committed by GitHub
parent 69cddadbe4
commit dd08a8e07d
23 changed files with 4242 additions and 1260 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -165,9 +165,8 @@ echo $response;
</CodeGroup>
<CodeGroup title="Response">
<CodeGroup title="Response">
```json {{ title: 'Example' }}
[
{
@@ -206,13 +205,10 @@ echo $response;
}
]
```
</CodeGroup>
</Col>
</CodeGroup>
</Col>
</Row>
---
@@ -225,43 +221,35 @@ echo $response;
Creates a new service user or sends an invite to a regular user
#### Request-Body Parameters
<Properties>
<Properties><Property name="email" type="string" required={false}>
<Property name="email" type="string" required={false}
>
User's Email to send invite to
</Property>
User's Email to send invite to
<Property name="name" type="string" required={false}
>
User's full name
</Property>
</Property>
<Property name="name" type="string" required={false}>
<Property name="role" type="string" required={true}
>
User's NetBird account role
</Property>
User's full name
<Property name="auto_groups" type="string[]" required={true}
>
Group IDs to auto-assign to peers registered by this user
</Property>
</Property>
<Property name="role" type="string" required={true}>
<Property name="is_service_user" type="boolean" required={true}
>
Is true if this user is a service user
</Property>
</Properties>
User's NetBird account role
</Property>
<Property name="auto_groups" type="string[]" required={true}>
Group IDs to auto-assign to peers registered by this user
</Property>
<Property name="is_service_user" type="boolean" required={true}>
Is true if this user is a service user
</Property>
</Properties>
</Col>
<Col sticky>
@@ -481,9 +469,8 @@ echo $response;
</CodeGroup>
<CodeGroup title="Response">
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"id": "google-oauth2|277474792786460067937",
@@ -518,13 +505,10 @@ echo $response;
"issued": "string"
}
```
</CodeGroup>
</Col>
</CodeGroup>
</Col>
</Row>
---
@@ -545,29 +529,25 @@ echo $response;
</Properties>
#### Request-Body Parameters
<Properties>
<Properties><Property name="role" type="string" required={true}>
<Property name="role" type="string" required={true}
>
User's NetBird account role
</Property>
User's NetBird account role
<Property name="auto_groups" type="string[]" required={true}
>
Group IDs to auto-assign to peers registered by this user
</Property>
</Property>
<Property name="auto_groups" type="string[]" required={true}>
<Property name="is_blocked" type="boolean" required={true}
>
If set to true then user is blocked and can't use the system
</Property>
</Properties>
Group IDs to auto-assign to peers registered by this user
</Property>
<Property name="is_blocked" type="boolean" required={true}>
If set to true then user is blocked and can't use the system
</Property>
</Properties>
</Col>
<Col sticky>
@@ -773,9 +753,8 @@ echo $response;
</CodeGroup>
<CodeGroup title="Response">
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"id": "google-oauth2|277474792786460067937",
@@ -810,13 +789,10 @@ echo $response;
"issued": "string"
}
```
</CodeGroup>
</Col>
</CodeGroup>
</Col>
</Row>
---
@@ -978,11 +954,9 @@ echo $response;
</CodeGroup>
</Col>
</Col>
</Row>
---
@@ -1144,11 +1118,9 @@ echo $response;
</CodeGroup>
</Col>
</Col>
</Row>
---