add examples to response

This commit is contained in:
Pascal Fischer
2023-05-05 18:00:13 +02:00
parent 2b65de30e4
commit adf57d5294
16 changed files with 1174 additions and 180 deletions

View File

@@ -4,7 +4,7 @@ export function HeroPattern() {
return (
<div className="absolute inset-0 -z-10 mx-0 max-w-none overflow-hidden">
<div className="absolute left-1/2 top-0 ml-[-38rem] h-[25rem] w-[81.25rem] dark:[mask-image:linear-gradient(white,transparent)]">
<div className="absolute inset-0 bg-gradient-to-r from-[#F39C12] to-[#FAD7A0] opacity-40 [mask-image:radial-gradient(farthest-side_at_top,white,transparent)] dark:from-[#F39C12]/30 dark:to-[#FAD7A0]/30 dark:opacity-100">
<div className="absolute inset-0 bg-gradient-to-r from-[#FFAC1C] to-[#FF5F15] opacity-40 [mask-image:radial-gradient(farthest-side_at_top,white,transparent)] dark:from-[#FFAC1C]/30 dark:to-[#FF5F15]/30 dark:opacity-100">
<GridPattern
width={72}
height={56}

View File

@@ -173,7 +173,18 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "ch8i4ug6lnn4g9hqv7l0",
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200
}
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
@@ -416,7 +427,16 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7l0",
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200
}
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"settings": {

View File

@@ -173,7 +173,31 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "Google DNS",
"description": "Google DNS servers",
"nameservers": [
{
"ip": "8.8.8.8",
"ns_type": "udp",
"port": 53
}
],
"enabled": true,
"groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"primary": true,
"domains": [
"example.com"
]
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
@@ -569,7 +593,29 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "Google DNS",
"description": "Google DNS servers",
"nameservers": [
{
"ip": "8.8.8.8",
"ns_type": "udp",
"port": 53
}
],
"enabled": true,
"groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"primary": true,
"domains": [
"example.com"
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
@@ -778,7 +824,29 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "Google DNS",
"description": "Google DNS servers",
"nameservers": [
{
"ip": "8.8.8.8",
"ns_type": "udp",
"port": 53
}
],
"enabled": true,
"groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"primary": true,
"domains": [
"example.com"
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
@@ -1180,7 +1248,29 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "Google DNS",
"description": "Google DNS servers",
"nameservers": [
{
"ip": "8.8.8.8",
"ns_type": "udp",
"port": 53
}
],
"enabled": true,
"groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"primary": true,
"domains": [
"example.com"
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
@@ -1563,7 +1653,16 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"disabled_management_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
}
]
```
```json {{ title: 'Schema' }}
[
{
"disabled_management_groups": [
@@ -1796,7 +1895,14 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"disabled_management_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
}
```
```json {{ title: 'Schema' }}
{
"disabled_management_groups": [
"string"

View File

@@ -173,7 +173,24 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "10",
"timestamp": "2023-05-05T10:04:37.473542Z",
"activity": "Route created",
"activity_code": "route.add",
"initiator_id": "google-oauth2|123456789012345678901",
"target_id": "chad9d86lnnc59g18ou0",
"meta": {
"name": "my route",
"network_range": "10.64.0.0/24",
"peer_id": "chacbco6lnnbn6cg5s91"
}
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",

View File

@@ -173,7 +173,22 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"peers": [
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1"
}
]
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
@@ -426,7 +441,20 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"peers": [
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1"
}
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
@@ -626,7 +654,20 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"peers": [
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1"
}
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
@@ -885,7 +926,20 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"peers": [
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1"
}
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",

View File

@@ -173,7 +173,35 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1",
"ip": "10.64.0.1",
"connected": true,
"last_seen": "2023-05-05T10:05:26.420578Z",
"os": "Darwin 13.2.1",
"version": "0.14.0",
"groups": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"ssh_enabled": true,
"user_id": "google-oauth2|277474792786460067937",
"hostname": "stage-host-1",
"ui_version": "0.14.0",
"dns_label": "stage-host-1.netbird.cloud",
"login_expiration_enabled": false,
"login_expired": false,
"last_login": "2023-05-05T09:00:35.477782Z"
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
@@ -388,7 +416,33 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1",
"ip": "10.64.0.1",
"connected": true,
"last_seen": "2023-05-05T10:05:26.420578Z",
"os": "Darwin 13.2.1",
"version": "0.14.0",
"groups": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"ssh_enabled": true,
"user_id": "google-oauth2|277474792786460067937",
"hostname": "stage-host-1",
"ui_version": "0.14.0",
"dns_label": "stage-host-1.netbird.cloud",
"login_expiration_enabled": false,
"login_expired": false,
"last_login": "2023-05-05T09:00:35.477782Z"
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
@@ -660,7 +714,33 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1",
"ip": "10.64.0.1",
"connected": true,
"last_seen": "2023-05-05T10:05:26.420578Z",
"os": "Darwin 13.2.1",
"version": "0.14.0",
"groups": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"ssh_enabled": true,
"user_id": "google-oauth2|277474792786460067937",
"hostname": "stage-host-1",
"ui_version": "0.14.0",
"dns_label": "stage-host-1.netbird.cloud",
"login_expiration_enabled": false,
"login_expired": false,
"last_login": "2023-05-05T09:00:35.477782Z"
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",

View File

@@ -173,7 +173,41 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"name": "ch8i4ug6lnn4g9hqv7mg",
"description": "This is a default policy that allows connections between all the resources",
"enabled": true,
"query": "package netbird\\n\\nall[rule] {\\n is_peer_in_any_group([\\\"ch8i4ug6lnn4g9hqv7m0\\\",\\\"ch8i4ug6lnn4g9hqv7m0\\\"])\\n rule := {\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"dst\\\", \\\"accept\\\", \\\"\\\"),\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"src\\\", \\\"accept\\\", \\\"\\\"),\\n }[_][_]\\n}\\n",
"rules": [
{
"id": "ch8i4ug6lnn4g9hqv7mg",
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"enabled": true,
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"action": "accept"
}
],
"id": "ch8i4ug6lnn4g9hqv7mg"
}
]
```
```json {{ title: 'Schema' }}
[
{
"name": "string",
@@ -627,7 +661,39 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"name": "ch8i4ug6lnn4g9hqv7mg",
"description": "This is a default policy that allows connections between all the resources",
"enabled": true,
"query": "package netbird\\n\\nall[rule] {\\n is_peer_in_any_group([\\\"ch8i4ug6lnn4g9hqv7m0\\\",\\\"ch8i4ug6lnn4g9hqv7m0\\\"])\\n rule := {\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"dst\\\", \\\"accept\\\", \\\"\\\"),\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"src\\\", \\\"accept\\\", \\\"\\\"),\\n }[_][_]\\n}\\n",
"rules": [
{
"id": "ch8i4ug6lnn4g9hqv7mg",
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"enabled": true,
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"action": "accept"
}
],
"id": "ch8i4ug6lnn4g9hqv7mg"
}
```
```json {{ title: 'Schema' }}
{
"name": "string",
"description": "string",
@@ -842,7 +908,39 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"name": "ch8i4ug6lnn4g9hqv7mg",
"description": "This is a default policy that allows connections between all the resources",
"enabled": true,
"query": "package netbird\\n\\nall[rule] {\\n is_peer_in_any_group([\\\"ch8i4ug6lnn4g9hqv7m0\\\",\\\"ch8i4ug6lnn4g9hqv7m0\\\"])\\n rule := {\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"dst\\\", \\\"accept\\\", \\\"\\\"),\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"src\\\", \\\"accept\\\", \\\"\\\"),\\n }[_][_]\\n}\\n",
"rules": [
{
"id": "ch8i4ug6lnn4g9hqv7mg",
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"enabled": true,
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"action": "accept"
}
],
"id": "ch8i4ug6lnn4g9hqv7mg"
}
```
```json {{ title: 'Schema' }}
{
"name": "string",
"description": "string",
@@ -1302,7 +1400,39 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"name": "ch8i4ug6lnn4g9hqv7mg",
"description": "This is a default policy that allows connections between all the resources",
"enabled": true,
"query": "package netbird\\n\\nall[rule] {\\n is_peer_in_any_group([\\\"ch8i4ug6lnn4g9hqv7m0\\\",\\\"ch8i4ug6lnn4g9hqv7m0\\\"])\\n rule := {\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"dst\\\", \\\"accept\\\", \\\"\\\"),\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"src\\\", \\\"accept\\\", \\\"\\\"),\\n }[_][_]\\n}\\n",
"rules": [
{
"id": "ch8i4ug6lnn4g9hqv7mg",
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"enabled": true,
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"action": "accept"
}
],
"id": "ch8i4ug6lnn4g9hqv7mg"
}
```
```json {{ title: 'Schema' }}
{
"name": "string",
"description": "string",

View File

@@ -173,7 +173,25 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "chacdk86lnnboviihd7g",
"network_type": "IPv4",
"description": "My first route",
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
"groups": [
"chacdk86lnnboviihd70"
]
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
@@ -521,7 +539,23 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "chacdk86lnnboviihd7g",
"network_type": "IPv4",
"description": "My first route",
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
"groups": [
"chacdk86lnnboviihd70"
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"network_type": "string",
@@ -724,7 +758,23 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "chacdk86lnnboviihd7g",
"network_type": "IPv4",
"description": "My first route",
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
"groups": [
"chacdk86lnnboviihd70"
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"network_type": "string",
@@ -1078,7 +1128,23 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "chacdk86lnnboviihd7g",
"network_type": "IPv4",
"description": "My first route",
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
"groups": [
"chacdk86lnnboviihd70"
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"network_type": "string",

View File

@@ -173,7 +173,32 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "ch8i4ug6lnn4g9hqv7mg",
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"disabled": false,
"flow": "bidirect",
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
]
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
@@ -506,7 +531,30 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7mg",
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"disabled": false,
"flow": "bidirect",
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
@@ -712,7 +760,30 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7mg",
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"disabled": false,
"flow": "bidirect",
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
@@ -1051,7 +1122,30 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7mg",
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"disabled": false,
"flow": "bidirect",
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
],
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2
}
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",

View File

@@ -173,7 +173,28 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "2531583362",
"key": "A616097E-FCF0-48FA-9354-CA4A61142761",
"name": "Default key",
"expires": "2023-06-01T14:47:22.291057Z",
"type": "reusable",
"valid": true,
"revoked": false,
"used_times": 2,
"last_used": "2023-05-05T09:00:35.477782Z",
"state": "valid",
"auto_groups": [
"devs"
],
"updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
@@ -488,7 +509,26 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "2531583362",
"key": "A616097E-FCF0-48FA-9354-CA4A61142761",
"name": "Default key",
"expires": "2023-06-01T14:47:22.291057Z",
"type": "reusable",
"valid": true,
"revoked": false,
"used_times": 2,
"last_used": "2023-05-05T09:00:35.477782Z",
"state": "valid",
"auto_groups": [
"devs"
],
"updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"key": "string",
@@ -694,7 +734,26 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "2531583362",
"key": "A616097E-FCF0-48FA-9354-CA4A61142761",
"name": "Default key",
"expires": "2023-06-01T14:47:22.291057Z",
"type": "reusable",
"valid": true,
"revoked": false,
"used_times": 2,
"last_used": "2023-05-05T09:00:35.477782Z",
"state": "valid",
"auto_groups": [
"devs"
],
"updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"key": "string",
@@ -1015,7 +1074,26 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "2531583362",
"key": "A616097E-FCF0-48FA-9354-CA4A61142761",
"name": "Default key",
"expires": "2023-06-01T14:47:22.291057Z",
"type": "reusable",
"valid": true,
"revoked": false,
"used_times": 2,
"last_used": "2023-05-05T09:00:35.477782Z",
"state": "valid",
"auto_groups": [
"devs"
],
"updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"key": "string",

View File

@@ -181,7 +181,19 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "ch8i54g6lnn4g9hqv7n0",
"name": "My first token",
"expiration_date": "2023-05-05T14:38:28.977616Z",
"created_by": "google-oauth2|277474792786460067937",
"created_at": "2023-05-02T14:48:20.465209Z",
"last_used": "2023-05-04T12:45:25.9723616Z"
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
@@ -429,7 +441,20 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"plain_token": "2023-05-02T14:48:20.465209Z",
"personal_access_token": {
"id": "ch8i54g6lnn4g9hqv7n0",
"name": "My first token",
"expiration_date": "2023-05-05T14:38:28.977616Z",
"created_by": "google-oauth2|277474792786460067937",
"created_at": "2023-05-02T14:48:20.465209Z",
"last_used": "2023-05-04T12:45:25.9723616Z"
}
}
```
```json {{ title: 'Schema' }}
{
"plain_token": "string",
"personal_access_token": {
@@ -633,7 +658,17 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "ch8i54g6lnn4g9hqv7n0",
"name": "My first token",
"expiration_date": "2023-05-05T14:38:28.977616Z",
"created_by": "google-oauth2|277474792786460067937",
"created_at": "2023-05-02T14:48:20.465209Z",
"last_used": "2023-05-04T12:45:25.9723616Z"
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",

View File

@@ -6,7 +6,7 @@ export const title = 'Users'
## Retrieve Users {{ tag: 'GET' , label: '/api/users' }}
## List all Users {{ tag: 'GET' , label: '/api/users' }}
<Row>
<Col>
@@ -181,7 +181,23 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
[
{
"id": "google-oauth2|277474792786460067937",
"email": "demo@netbird.io",
"name": "Tom Schulz",
"role": "admin",
"status": "active",
"auto_groups": [
"devs"
],
"is_current": true,
"is_service_user": false
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
@@ -477,7 +493,21 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "google-oauth2|277474792786460067937",
"email": "demo@netbird.io",
"name": "Tom Schulz",
"role": "admin",
"status": "active",
"auto_groups": [
"devs"
],
"is_current": true,
"is_service_user": false
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"email": "string",
@@ -737,7 +767,21 @@ echo $response;
<CodeGroup title="Response">
```json {{ title: '200' }}
```json {{ title: 'Example' }}
{
"id": "google-oauth2|277474792786460067937",
"email": "demo@netbird.io",
"name": "Tom Schulz",
"role": "admin",
"status": "active",
"auto_groups": [
"devs"
],
"is_current": true,
"is_service_user": false
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"email": "string",