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

Link Networks API (#265)

Browse Source 
* update side menu to link networks

* change heading
This commit is contained in:
Pascal Fischer
2024-12-24 11:12:09 +01:00
committed by GitHub
parent 81001b562c
commit c8683cc7e2
14 changed files with 75 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
generator/templates/ApiTemplate.ts
View File

@@ -10,7 +10,7 @@ export const title = '<%- tag %>'
<Col> <Col>
<%- operation.description %> <%- operation.description %>
<% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'path').length > 0){ %> <% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'path').length > 0){ %>
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<% operation.parameters.filter((parameter) => parameter.in === 'path').forEach(function(parameter){ %> <% operation.parameters.filter((parameter) => parameter.in === 'path').forEach(function(parameter){ %>
<Property name="<%- parameter.name %>" type="string" required=\{true\}> <Property name="<%- parameter.name %>" type="string" required=\{true\}>
@@ -20,7 +20,7 @@ export const title = '<%- tag %>'
</Properties> </Properties>
<% }; -%> <% }; -%>
<% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'query').length > 0){ %> <% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'query').length > 0){ %>
#### Query Parameters ### Query Parameters
<Properties> <Properties>
<% operation.parameters.filter((parameter) => parameter.in === 'query').forEach(function(parameter){ %> <% operation.parameters.filter((parameter) => parameter.in === 'query').forEach(function(parameter){ %>
<Property name="<%- parameter.name %>" type="<%- parameter.schema.type %>" required=\{false\}> <Property name="<%- parameter.name %>" type="<%- parameter.schema.type %>" required=\{false\}>
@@ -30,7 +30,7 @@ export const title = '<%- tag %>'
</Properties> </Properties>
<% }; -%> <% }; -%>
<% if(operation.requestBody && operation.requestBody["content"]["application/json"].schema.properties){ %> <% if(operation.requestBody && operation.requestBody["content"]["application/json"].schema.properties){ %>
#### Request-Body Parameters ### Request-Body Parameters
<% <%
function renderProperties(properties, required = [], depth = 0) { function renderProperties(properties, required = [], depth = 0) {

3
src/components/NavigationAPI.jsx
View File

@@ -30,7 +30,8 @@ export const apiNavigation = [
{ title: 'Policies', href: '/api/resources/policies' }, { title: 'Policies', href: '/api/resources/policies' },
{ title: 'Posture-Checks', href: '/api/resources/posture-checks' }, { title: 'Posture-Checks', href: '/api/resources/posture-checks' },
{ title: 'Geo-Locations', href: '/api/resources/geo-locations' }, { title: 'Geo-Locations', href: '/api/resources/geo-locations' },
{ title: 'Routes', href: '/api/resources/routes' }, { title: 'Routes (deprecated)', href: '/api/resources/routes' },
{ title: 'Networks', href: '/api/resources/networks' },
{ title: 'DNS', href: '/api/resources/dns' }, { title: 'DNS', href: '/api/resources/dns' },
{ title: 'Events', href: '/api/resources/events' }, { title: 'Events', href: '/api/resources/events' },
], ],

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

@@ -222,7 +222,7 @@ echo $response;
<Col> <Col>
Deletes an account and all its resources. Only account owners can delete accounts. Deletes an account and all its resources. Only account owners can delete accounts.
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="accountId" type="string" required={true}> <Property name="accountId" type="string" required={true}>
@@ -386,7 +386,7 @@ echo $response;
<Col> <Col>
Update information about an account Update information about an account
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="accountId" type="string" required={true}> <Property name="accountId" type="string" required={true}>
@@ -394,7 +394,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="settings" type="object" required={true}> <Properties><Property name="settings" type="object" required={true}>

12
src/pages/ipa/resources/dns.mdx
View File

@@ -224,7 +224,7 @@ echo $response;
<Col> <Col>
Creates a Nameserver Group Creates a Nameserver Group
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true} minLen={1} maxLen={40}> <Properties><Property name="name" type="string" required={true} minLen={1} maxLen={40}>
@@ -650,7 +650,7 @@ echo $response;
<Col> <Col>
Get information about a Nameserver Groups Get information about a Nameserver Groups
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="nsgroupId" type="string" required={true}> <Property name="nsgroupId" type="string" required={true}>
@@ -870,7 +870,7 @@ echo $response;
<Col> <Col>
Update/Replace a Nameserver Group Update/Replace a Nameserver Group
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="nsgroupId" type="string" required={true}> <Property name="nsgroupId" type="string" required={true}>
@@ -878,7 +878,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true} minLen={1} maxLen={40}> <Properties><Property name="name" type="string" required={true} minLen={1} maxLen={40}>
@@ -1304,7 +1304,7 @@ echo $response;
<Col> <Col>
Delete a Nameserver Group Delete a Nameserver Group
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="nsgroupId" type="string" required={true}> <Property name="nsgroupId" type="string" required={true}>
@@ -1652,7 +1652,7 @@ echo $response;
<Col> <Col>
Updates a DNS settings object Updates a DNS settings object
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="disabled_management_groups" type="string[]" required={true}> <Properties><Property name="disabled_management_groups" type="string[]" required={true}>

2
src/pages/ipa/resources/geo-locations.mdx
View File

@@ -184,7 +184,7 @@ echo $response;
<Col> <Col>
Get a list of all English city names for a given country code Get a list of all English city names for a given country code
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="country" type="string" required={true}> <Property name="country" type="string" required={true}>

10
src/pages/ipa/resources/groups.mdx
View File

@@ -220,7 +220,7 @@ echo $response;
<Col> <Col>
Creates a group Creates a group
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -556,7 +556,7 @@ echo $response;
<Col> <Col>
Get information about a group Get information about a group
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="groupId" type="string" required={true}> <Property name="groupId" type="string" required={true}>
@@ -772,7 +772,7 @@ echo $response;
<Col> <Col>
Update/Replace a group Update/Replace a group
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="groupId" type="string" required={true}> <Property name="groupId" type="string" required={true}>
@@ -780,7 +780,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -1116,7 +1116,7 @@ echo $response;
<Col> <Col>
Delete a group Delete a group
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="groupId" type="string" required={true}> <Property name="groupId" type="string" required={true}>

38
src/pages/ipa/resources/networks.mdx
View File

@@ -212,7 +212,7 @@ echo $response;
<Col> <Col>
Creates a Network Creates a Network
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -462,7 +462,7 @@ echo $response;
<Col> <Col>
Get information about a Network Get information about a Network
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -670,7 +670,7 @@ echo $response;
<Col> <Col>
Update/Replace a Network Update/Replace a Network
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -678,7 +678,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -928,7 +928,7 @@ echo $response;
<Col> <Col>
Delete a network Delete a network
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -1092,7 +1092,7 @@ echo $response;
<Col> <Col>
Returns a list of all resources in a network Returns a list of all resources in a network
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -1306,7 +1306,7 @@ echo $response;
<Col> <Col>
Creates a Network Resource Creates a Network Resource
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -1314,7 +1314,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -1604,7 +1604,7 @@ echo $response;
<Col> <Col>
Get information about a Network Resource Get information about a Network Resource
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -1818,7 +1818,7 @@ echo $response;
<Col> <Col>
Update a Network Resource Update a Network Resource
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -1830,7 +1830,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -2120,7 +2120,7 @@ echo $response;
<Col> <Col>
Delete a network resource Delete a network resource
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -2288,7 +2288,7 @@ echo $response;
<Col> <Col>
Returns a list of all routers in a network Returns a list of all routers in a network
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -2488,7 +2488,7 @@ echo $response;
<Col> <Col>
Creates a Network Router Creates a Network Router
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -2496,7 +2496,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="peer" type="string" required={false}> <Properties><Property name="peer" type="string" required={false}>
@@ -2772,7 +2772,7 @@ echo $response;
<Col> <Col>
Get information about a Network Router Get information about a Network Router
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -2972,7 +2972,7 @@ echo $response;
<Col> <Col>
Update a Network Router Update a Network Router
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>
@@ -2984,7 +2984,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="peer" type="string" required={false}> <Properties><Property name="peer" type="string" required={false}>
@@ -3260,7 +3260,7 @@ echo $response;
<Col> <Col>
Delete a network router Delete a network router
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="networkId" type="string" required={true}> <Property name="networkId" type="string" required={true}>

10
src/pages/ipa/resources/peers.mdx
View File

@@ -252,7 +252,7 @@ echo $response;
<Col> <Col>
Get information about a peer Get information about a peer
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="peerId" type="string" required={true}> <Property name="peerId" type="string" required={true}>
@@ -498,7 +498,7 @@ echo $response;
<Col> <Col>
Update information about a peer Update information about a peer
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="peerId" type="string" required={true}> <Property name="peerId" type="string" required={true}>
@@ -506,7 +506,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -830,7 +830,7 @@ echo $response;
<Col> <Col>
Delete a peer Delete a peer
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="peerId" type="string" required={true}> <Property name="peerId" type="string" required={true}>
@@ -994,7 +994,7 @@ echo $response;
<Col> <Col>
Returns a list of peers that the specified peer can connect to within the network. Returns a list of peers that the specified peer can connect to within the network.
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="peerId" type="string" required={true}> <Property name="peerId" type="string" required={true}>

10
src/pages/ipa/resources/policies.mdx
View File

@@ -292,7 +292,7 @@ echo $response;
<Col> <Col>
Creates a policy Creates a policy
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="id" type="string" required={false}> <Properties><Property name="id" type="string" required={false}>
@@ -1038,7 +1038,7 @@ echo $response;
<Col> <Col>
Get information about a Policies Get information about a Policies
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="policyId" type="string" required={true}> <Property name="policyId" type="string" required={true}>
@@ -1326,7 +1326,7 @@ echo $response;
<Col> <Col>
Update/Replace a Policy Update/Replace a Policy
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="policyId" type="string" required={true}> <Property name="policyId" type="string" required={true}>
@@ -1334,7 +1334,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="id" type="string" required={false}> <Properties><Property name="id" type="string" required={false}>
@@ -2080,7 +2080,7 @@ echo $response;
<Col> <Col>
Delete a policy Delete a policy
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="policyId" type="string" required={true}> <Property name="policyId" type="string" required={true}>

10
src/pages/ipa/resources/posture-checks.mdx
View File

@@ -286,7 +286,7 @@ echo $response;
<Col> <Col>
Creates a posture check Creates a posture check
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -1172,7 +1172,7 @@ echo $response;
<Col> <Col>
Get information about a posture check Get information about a posture check
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="postureCheckId" type="string" required={true}> <Property name="postureCheckId" type="string" required={true}>
@@ -1454,7 +1454,7 @@ echo $response;
<Col> <Col>
Update/Replace a posture check Update/Replace a posture check
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="postureCheckId" type="string" required={true}> <Property name="postureCheckId" type="string" required={true}>
@@ -1462,7 +1462,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -2348,7 +2348,7 @@ echo $response;
<Col> <Col>
Delete a posture check Delete a posture check
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="postureCheckId" type="string" required={true}> <Property name="postureCheckId" type="string" required={true}>

10
src/pages/ipa/resources/routes.mdx
View File

@@ -230,7 +230,7 @@ echo $response;
<Col> <Col>
Creates a Route Creates a Route
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="description" type="string" required={true}> <Properties><Property name="description" type="string" required={true}>
@@ -674,7 +674,7 @@ echo $response;
<Col> <Col>
Get information about a Routes Get information about a Routes
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="routeId" type="string" required={true}> <Property name="routeId" type="string" required={true}>
@@ -900,7 +900,7 @@ echo $response;
<Col> <Col>
Update/Replace a Route Update/Replace a Route
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="routeId" type="string" required={true}> <Property name="routeId" type="string" required={true}>
@@ -908,7 +908,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="description" type="string" required={true}> <Properties><Property name="description" type="string" required={true}>
@@ -1352,7 +1352,7 @@ echo $response;
<Col> <Col>
Delete a route Delete a route
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="routeId" type="string" required={true}> <Property name="routeId" type="string" required={true}>

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

@@ -218,7 +218,7 @@ echo $response;
<Col> <Col>
Creates a setup key Creates a setup key
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -536,7 +536,7 @@ echo $response;
<Col> <Col>
Get information about a setup key Get information about a setup key
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="keyId" type="string" required={true}> <Property name="keyId" type="string" required={true}>
@@ -750,7 +750,7 @@ echo $response;
<Col> <Col>
Update information about a setup key Update information about a setup key
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="keyId" type="string" required={true}> <Property name="keyId" type="string" required={true}>
@@ -758,7 +758,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="revoked" type="boolean" required={true}> <Properties><Property name="revoked" type="boolean" required={true}>
@@ -1028,7 +1028,7 @@ echo $response;
<Col> <Col>
Delete a Setup Key Delete a Setup Key
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="keyId" type="string" required={true}> <Property name="keyId" type="string" required={true}>

10
src/pages/ipa/resources/tokens.mdx
View File

@@ -8,7 +8,7 @@ export const title = 'Tokens'
<Col> <Col>
Returns a list of all tokens for a user Returns a list of all tokens for a user
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="userId" type="string" required={true}> <Property name="userId" type="string" required={true}>
@@ -206,7 +206,7 @@ echo $response;
<Col> <Col>
Create a new token for a user Create a new token for a user
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="userId" type="string" required={true}> <Property name="userId" type="string" required={true}>
@@ -214,7 +214,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}> <Properties><Property name="name" type="string" required={true}>
@@ -456,7 +456,7 @@ echo $response;
<Col> <Col>
Returns a specific token for a user Returns a specific token for a user
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="userId" type="string" required={true}> <Property name="userId" type="string" required={true}>
@@ -654,7 +654,7 @@ echo $response;
<Col> <Col>
Delete a token for a user Delete a token for a user
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="userId" type="string" required={true}> <Property name="userId" type="string" required={true}>

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

@@ -8,7 +8,7 @@ export const title = 'Users'
<Col> <Col>
Returns a list of all users Returns a list of all users
#### Query Parameters ### Query Parameters
<Properties> <Properties>
<Property name="service_user" type="boolean" required={false}> <Property name="service_user" type="boolean" required={false}>
@@ -226,7 +226,7 @@ echo $response;
<Col> <Col>
Creates a new service user or sends an invite to a regular user Creates a new service user or sends an invite to a regular user
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="email" type="string" required={false}> <Properties><Property name="email" type="string" required={false}>
@@ -532,7 +532,7 @@ echo $response;
<Col> <Col>
Update information about a User Update information about a User
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="userId" type="string" required={true}> <Property name="userId" type="string" required={true}>
@@ -540,7 +540,7 @@ echo $response;
</Property> </Property>
</Properties> </Properties>
#### Request-Body Parameters ### Request-Body Parameters
<Properties><Property name="role" type="string" required={true}> <Properties><Property name="role" type="string" required={true}>
@@ -822,7 +822,7 @@ echo $response;
<Col> <Col>
This method removes a user from accessing the system. For this leaves the IDP user intact unless the `--user-delete-from-idp` is passed to management startup. This method removes a user from accessing the system. For this leaves the IDP user intact unless the `--user-delete-from-idp` is passed to management startup.
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="userId" type="string" required={true}> <Property name="userId" type="string" required={true}>
@@ -986,7 +986,7 @@ echo $response;
<Col> <Col>
Resend user invitation Resend user invitation
#### Path Parameters ### Path Parameters
<Properties> <Properties>
<Property name="userId" type="string" required={true}> <Property name="userId" type="string" required={true}>