Skip to content

Commit

Permalink
Link Networks API (#265)
Browse files Browse the repository at this point in the history 
* update side menu to link networks

* change heading
  • Loading branch information
@pascal-fischer
pascal-fischer authored Dec 24, 2024
1 parent 81001b5 commit c8683cc
Show file tree
Hide file tree
Showing 14 changed files with 75 additions and 74 deletions.
6 changes: 3 additions & 3 deletions generator/templates/ApiTemplate.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export const title = '<%- tag %>'
<Col>
<%- operation.description %>
<% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'path').length > 0){ %>
#### Path Parameters
### Path Parameters
<Properties>
<% operation.parameters.filter((parameter) => parameter.in === 'path').forEach(function(parameter){ %>
<Property name="<%- parameter.name %>" type="string" required=\{true\}>
Expand All @@ -20,7 +20,7 @@ export const title = '<%- tag %>'
</Properties>
<% }; -%>
<% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'query').length > 0){ %>
#### Query Parameters
### Query Parameters
<Properties>
<% operation.parameters.filter((parameter) => parameter.in === 'query').forEach(function(parameter){ %>
<Property name="<%- parameter.name %>" type="<%- parameter.schema.type %>" required=\{false\}>
Expand All @@ -30,7 +30,7 @@ export const title = '<%- tag %>'
</Properties>
<% }; -%>
<% if(operation.requestBody && operation.requestBody["content"]["application/json"].schema.properties){ %>
#### Request-Body Parameters
### Request-Body Parameters
<%
function renderProperties(properties, required = [], depth = 0) {
Expand Down
3 changes: 2 additions & 1 deletion src/components/NavigationAPI.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ export const apiNavigation = [
{ title: 'Policies', href: '/api/resources/policies' },
{ title: 'Posture-Checks', href: '/api/resources/posture-checks' },
{ 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: 'Events', href: '/api/resources/events' },
],
Expand Down
6 changes: 3 additions & 3 deletions src/pages/ipa/resources/accounts.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ echo $response;
<Col>
Deletes an account and all its resources. Only account owners can delete accounts.
#### Path Parameters
### Path Parameters
<Properties>
<Property name="accountId" type="string" required={true}>
Expand Down Expand Up @@ -386,15 +386,15 @@ echo $response;
<Col>
Update information about an account
#### Path Parameters
### Path Parameters
<Properties>
<Property name="accountId" type="string" required={true}>
The unique identifier of an account
</Property>
</Properties>
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="settings" type="object" required={true}>
Expand Down
12 changes: 6 additions & 6 deletions src/pages/ipa/resources/dns.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ echo $response;
<Col>
Creates a Nameserver Group
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true} minLen={1} maxLen={40}>
Expand Down Expand Up @@ -650,7 +650,7 @@ echo $response;
<Col>
Get information about a Nameserver Groups
#### Path Parameters
### Path Parameters
<Properties>
<Property name="nsgroupId" type="string" required={true}>
Expand Down Expand Up @@ -870,15 +870,15 @@ echo $response;
<Col>
Update/Replace a Nameserver Group
#### Path Parameters
### Path Parameters
<Properties>
<Property name="nsgroupId" type="string" required={true}>
The unique identifier of a Nameserver Group
</Property>
</Properties>
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true} minLen={1} maxLen={40}>
Expand Down Expand Up @@ -1304,7 +1304,7 @@ echo $response;
<Col>
Delete a Nameserver Group
#### Path Parameters
### Path Parameters
<Properties>
<Property name="nsgroupId" type="string" required={true}>
Expand Down Expand Up @@ -1652,7 +1652,7 @@ echo $response;
<Col>
Updates a DNS settings object
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="disabled_management_groups" type="string[]" required={true}>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/ipa/resources/geo-locations.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ echo $response;
<Col>
Get a list of all English city names for a given country code
#### Path Parameters
### Path Parameters
<Properties>
<Property name="country" type="string" required={true}>
Expand Down
10 changes: 5 additions & 5 deletions src/pages/ipa/resources/groups.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ echo $response;
<Col>
Creates a group
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Expand Down Expand Up @@ -556,7 +556,7 @@ echo $response;
<Col>
Get information about a group
#### Path Parameters
### Path Parameters
<Properties>
<Property name="groupId" type="string" required={true}>
Expand Down Expand Up @@ -772,15 +772,15 @@ echo $response;
<Col>
Update/Replace a group
#### Path Parameters
### Path Parameters
<Properties>
<Property name="groupId" type="string" required={true}>
The unique identifier of a group
</Property>
</Properties>
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Expand Down Expand Up @@ -1116,7 +1116,7 @@ echo $response;
<Col>
Delete a group
#### Path Parameters
### Path Parameters
<Properties>
<Property name="groupId" type="string" required={true}>
Expand Down
38 changes: 19 additions & 19 deletions src/pages/ipa/resources/networks.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ echo $response;
<Col>
Creates a Network
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Expand Down Expand Up @@ -462,7 +462,7 @@ echo $response;
<Col>
Get information about a Network
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand Down Expand Up @@ -670,15 +670,15 @@ echo $response;
<Col>
Update/Replace a Network
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
The unique identifier of a network
</Property>
</Properties>
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Expand Down Expand Up @@ -928,7 +928,7 @@ echo $response;
<Col>
Delete a network
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand Down Expand Up @@ -1092,7 +1092,7 @@ echo $response;
<Col>
Returns a list of all resources in a network
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand Down Expand Up @@ -1306,15 +1306,15 @@ echo $response;
<Col>
Creates a Network Resource
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
The unique identifier of a network
</Property>
</Properties>
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Expand Down Expand Up @@ -1604,7 +1604,7 @@ echo $response;
<Col>
Get information about a Network Resource
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand Down Expand Up @@ -1818,7 +1818,7 @@ echo $response;
<Col>
Update a Network Resource
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand All @@ -1830,7 +1830,7 @@ echo $response;
</Property>
</Properties>
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Expand Down Expand Up @@ -2120,7 +2120,7 @@ echo $response;
<Col>
Delete a network resource
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand Down Expand Up @@ -2288,7 +2288,7 @@ echo $response;
<Col>
Returns a list of all routers in a network
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand Down Expand Up @@ -2488,15 +2488,15 @@ echo $response;
<Col>
Creates a Network Router
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
The unique identifier of a network
</Property>
</Properties>
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="peer" type="string" required={false}>
Expand Down Expand Up @@ -2772,7 +2772,7 @@ echo $response;
<Col>
Get information about a Network Router
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand Down Expand Up @@ -2972,7 +2972,7 @@ echo $response;
<Col>
Update a Network Router
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand All @@ -2984,7 +2984,7 @@ echo $response;
</Property>
</Properties>
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="peer" type="string" required={false}>
Expand Down Expand Up @@ -3260,7 +3260,7 @@ echo $response;
<Col>
Delete a network router
#### Path Parameters
### Path Parameters
<Properties>
<Property name="networkId" type="string" required={true}>
Expand Down
10 changes: 5 additions & 5 deletions src/pages/ipa/resources/peers.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ echo $response;
<Col>
Get information about a peer
#### Path Parameters
### Path Parameters
<Properties>
<Property name="peerId" type="string" required={true}>
Expand Down Expand Up @@ -498,15 +498,15 @@ echo $response;
<Col>
Update information about a peer
#### Path Parameters
### Path Parameters
<Properties>
<Property name="peerId" type="string" required={true}>
The unique identifier of a peer
</Property>
</Properties>
#### Request-Body Parameters
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Expand Down Expand Up @@ -830,7 +830,7 @@ echo $response;
<Col>
Delete a peer
#### Path Parameters
### Path Parameters
<Properties>
<Property name="peerId" type="string" required={true}>
Expand Down Expand Up @@ -994,7 +994,7 @@ echo $response;
<Col>
Returns a list of peers that the specified peer can connect to within the network.
#### Path Parameters
### Path Parameters
<Properties>
<Property name="peerId" type="string" required={true}>
Expand Down
Loading

0 comments on commit c8683cc

Please sign in to comment.