Skip to content

Commit c8683cc

Browse files
pascal-fischerpascal-fischer
authored
Link Networks API (#265)
* update side menu to link networks * change heading
1 parent 81001b5 commit c8683cc

File tree

14 files changed

+75
-74
lines changed

14 files changed

+75
-74
lines changed

‎generator/templates/ApiTemplate.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const title = '<%- tag %>'
1010
<Col>
1111
<%- operation.description %>
1212
<% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'path').length > 0){ %>
13-
#### Path Parameters
13+
### Path Parameters
1414
<Properties>
1515
<% operation.parameters.filter((parameter) => parameter.in === 'path').forEach(function(parameter){ %>
1616
<Property name="<%- parameter.name %>" type="string" required=\{true\}>
@@ -20,7 +20,7 @@ export const title = '<%- tag %>'
2020
</Properties>
2121
<% }; -%>
2222
<% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'query').length > 0){ %>
23-
#### Query Parameters
23+
### Query Parameters
2424
<Properties>
2525
<% operation.parameters.filter((parameter) => parameter.in === 'query').forEach(function(parameter){ %>
2626
<Property name="<%- parameter.name %>" type="<%- parameter.schema.type %>" required=\{false\}>
@@ -30,7 +30,7 @@ export const title = '<%- tag %>'
3030
</Properties>
3131
<% }; -%>
3232
<% if(operation.requestBody && operation.requestBody["content"]["application/json"].schema.properties){ %>
33-
#### Request-Body Parameters
33+
### Request-Body Parameters
3434
3535
<%
3636
function renderProperties(properties, required = [], depth = 0) {

‎src/components/NavigationAPI.jsx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ export const apiNavigation = [
3030
{ title: 'Policies', href: '/api/resources/policies' },
3131
{ title: 'Posture-Checks', href: '/api/resources/posture-checks' },
3232
{ title: 'Geo-Locations', href: '/api/resources/geo-locations' },
33-
{ title: 'Routes', href: '/api/resources/routes' },
33+
{ title: 'Routes (deprecated)', href: '/api/resources/routes' },
34+
{ title: 'Networks', href: '/api/resources/networks' },
3435
{ title: 'DNS', href: '/api/resources/dns' },
3536
{ title: 'Events', href: '/api/resources/events' },
3637
],

‎src/pages/ipa/resources/accounts.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ echo $response;
222222
<Col>
223223
Deletes an account and all its resources. Only account owners can delete accounts.
224224
225-
#### Path Parameters
225+
### Path Parameters
226226
<Properties>
227227
228228
<Property name="accountId" type="string" required={true}>
@@ -386,15 +386,15 @@ echo $response;
386386
<Col>
387387
Update information about an account
388388
389-
#### Path Parameters
389+
### Path Parameters
390390
<Properties>
391391
392392
<Property name="accountId" type="string" required={true}>
393393
The unique identifier of an account
394394
</Property>
395395
</Properties>
396396
397-
#### Request-Body Parameters
397+
### Request-Body Parameters
398398
399399
<Properties><Property name="settings" type="object" required={true}>
400400

‎src/pages/ipa/resources/dns.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ echo $response;
224224
<Col>
225225
Creates a Nameserver Group
226226
227-
#### Request-Body Parameters
227+
### Request-Body Parameters
228228
229229
<Properties><Property name="name" type="string" required={true} minLen={1} maxLen={40}>
230230
@@ -650,7 +650,7 @@ echo $response;
650650
<Col>
651651
Get information about a Nameserver Groups
652652
653-
#### Path Parameters
653+
### Path Parameters
654654
<Properties>
655655
656656
<Property name="nsgroupId" type="string" required={true}>
@@ -870,15 +870,15 @@ echo $response;
870870
<Col>
871871
Update/Replace a Nameserver Group
872872
873-
#### Path Parameters
873+
### Path Parameters
874874
<Properties>
875875
876876
<Property name="nsgroupId" type="string" required={true}>
877877
The unique identifier of a Nameserver Group
878878
</Property>
879879
</Properties>
880880
881-
#### Request-Body Parameters
881+
### Request-Body Parameters
882882
883883
<Properties><Property name="name" type="string" required={true} minLen={1} maxLen={40}>
884884
@@ -1304,7 +1304,7 @@ echo $response;
13041304
<Col>
13051305
Delete a Nameserver Group
13061306
1307-
#### Path Parameters
1307+
### Path Parameters
13081308
<Properties>
13091309
13101310
<Property name="nsgroupId" type="string" required={true}>
@@ -1652,7 +1652,7 @@ echo $response;
16521652
<Col>
16531653
Updates a DNS settings object
16541654
1655-
#### Request-Body Parameters
1655+
### Request-Body Parameters
16561656
16571657
<Properties><Property name="disabled_management_groups" type="string[]" required={true}>
16581658

‎src/pages/ipa/resources/geo-locations.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ echo $response;
184184
<Col>
185185
Get a list of all English city names for a given country code
186186
187-
#### Path Parameters
187+
### Path Parameters
188188
<Properties>
189189
190190
<Property name="country" type="string" required={true}>

‎src/pages/ipa/resources/groups.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ echo $response;
220220
<Col>
221221
Creates a group
222222
223-
#### Request-Body Parameters
223+
### Request-Body Parameters
224224
225225
<Properties><Property name="name" type="string" required={true}>
226226
@@ -556,7 +556,7 @@ echo $response;
556556
<Col>
557557
Get information about a group
558558
559-
#### Path Parameters
559+
### Path Parameters
560560
<Properties>
561561
562562
<Property name="groupId" type="string" required={true}>
@@ -772,15 +772,15 @@ echo $response;
772772
<Col>
773773
Update/Replace a group
774774
775-
#### Path Parameters
775+
### Path Parameters
776776
<Properties>
777777
778778
<Property name="groupId" type="string" required={true}>
779779
The unique identifier of a group
780780
</Property>
781781
</Properties>
782782
783-
#### Request-Body Parameters
783+
### Request-Body Parameters
784784
785785
<Properties><Property name="name" type="string" required={true}>
786786
@@ -1116,7 +1116,7 @@ echo $response;
11161116
<Col>
11171117
Delete a group
11181118
1119-
#### Path Parameters
1119+
### Path Parameters
11201120
<Properties>
11211121
11221122
<Property name="groupId" type="string" required={true}>

‎src/pages/ipa/resources/networks.mdx‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ echo $response;
212212
<Col>
213213
Creates a Network
214214
215-
#### Request-Body Parameters
215+
### Request-Body Parameters
216216
217217
<Properties><Property name="name" type="string" required={true}>
218218
@@ -462,7 +462,7 @@ echo $response;
462462
<Col>
463463
Get information about a Network
464464
465-
#### Path Parameters
465+
### Path Parameters
466466
<Properties>
467467
468468
<Property name="networkId" type="string" required={true}>
@@ -670,15 +670,15 @@ echo $response;
670670
<Col>
671671
Update/Replace a Network
672672
673-
#### Path Parameters
673+
### Path Parameters
674674
<Properties>
675675
676676
<Property name="networkId" type="string" required={true}>
677677
The unique identifier of a network
678678
</Property>
679679
</Properties>
680680
681-
#### Request-Body Parameters
681+
### Request-Body Parameters
682682
683683
<Properties><Property name="name" type="string" required={true}>
684684
@@ -928,7 +928,7 @@ echo $response;
928928
<Col>
929929
Delete a network
930930
931-
#### Path Parameters
931+
### Path Parameters
932932
<Properties>
933933
934934
<Property name="networkId" type="string" required={true}>
@@ -1092,7 +1092,7 @@ echo $response;
10921092
<Col>
10931093
Returns a list of all resources in a network
10941094
1095-
#### Path Parameters
1095+
### Path Parameters
10961096
<Properties>
10971097
10981098
<Property name="networkId" type="string" required={true}>
@@ -1306,15 +1306,15 @@ echo $response;
13061306
<Col>
13071307
Creates a Network Resource
13081308
1309-
#### Path Parameters
1309+
### Path Parameters
13101310
<Properties>
13111311
13121312
<Property name="networkId" type="string" required={true}>
13131313
The unique identifier of a network
13141314
</Property>
13151315
</Properties>
13161316
1317-
#### Request-Body Parameters
1317+
### Request-Body Parameters
13181318
13191319
<Properties><Property name="name" type="string" required={true}>
13201320
@@ -1604,7 +1604,7 @@ echo $response;
16041604
<Col>
16051605
Get information about a Network Resource
16061606
1607-
#### Path Parameters
1607+
### Path Parameters
16081608
<Properties>
16091609
16101610
<Property name="networkId" type="string" required={true}>
@@ -1818,7 +1818,7 @@ echo $response;
18181818
<Col>
18191819
Update a Network Resource
18201820
1821-
#### Path Parameters
1821+
### Path Parameters
18221822
<Properties>
18231823
18241824
<Property name="networkId" type="string" required={true}>
@@ -1830,7 +1830,7 @@ echo $response;
18301830
</Property>
18311831
</Properties>
18321832
1833-
#### Request-Body Parameters
1833+
### Request-Body Parameters
18341834
18351835
<Properties><Property name="name" type="string" required={true}>
18361836
@@ -2120,7 +2120,7 @@ echo $response;
21202120
<Col>
21212121
Delete a network resource
21222122
2123-
#### Path Parameters
2123+
### Path Parameters
21242124
<Properties>
21252125
21262126
<Property name="networkId" type="string" required={true}>
@@ -2288,7 +2288,7 @@ echo $response;
22882288
<Col>
22892289
Returns a list of all routers in a network
22902290
2291-
#### Path Parameters
2291+
### Path Parameters
22922292
<Properties>
22932293
22942294
<Property name="networkId" type="string" required={true}>
@@ -2488,15 +2488,15 @@ echo $response;
24882488
<Col>
24892489
Creates a Network Router
24902490
2491-
#### Path Parameters
2491+
### Path Parameters
24922492
<Properties>
24932493
24942494
<Property name="networkId" type="string" required={true}>
24952495
The unique identifier of a network
24962496
</Property>
24972497
</Properties>
24982498
2499-
#### Request-Body Parameters
2499+
### Request-Body Parameters
25002500
25012501
<Properties><Property name="peer" type="string" required={false}>
25022502
@@ -2772,7 +2772,7 @@ echo $response;
27722772
<Col>
27732773
Get information about a Network Router
27742774
2775-
#### Path Parameters
2775+
### Path Parameters
27762776
<Properties>
27772777
27782778
<Property name="networkId" type="string" required={true}>
@@ -2972,7 +2972,7 @@ echo $response;
29722972
<Col>
29732973
Update a Network Router
29742974
2975-
#### Path Parameters
2975+
### Path Parameters
29762976
<Properties>
29772977
29782978
<Property name="networkId" type="string" required={true}>
@@ -2984,7 +2984,7 @@ echo $response;
29842984
</Property>
29852985
</Properties>
29862986
2987-
#### Request-Body Parameters
2987+
### Request-Body Parameters
29882988
29892989
<Properties><Property name="peer" type="string" required={false}>
29902990
@@ -3260,7 +3260,7 @@ echo $response;
32603260
<Col>
32613261
Delete a network router
32623262
3263-
#### Path Parameters
3263+
### Path Parameters
32643264
<Properties>
32653265
32663266
<Property name="networkId" type="string" required={true}>

‎src/pages/ipa/resources/peers.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ echo $response;
252252
<Col>
253253
Get information about a peer
254254
255-
#### Path Parameters
255+
### Path Parameters
256256
<Properties>
257257
258258
<Property name="peerId" type="string" required={true}>
@@ -498,15 +498,15 @@ echo $response;
498498
<Col>
499499
Update information about a peer
500500
501-
#### Path Parameters
501+
### Path Parameters
502502
<Properties>
503503
504504
<Property name="peerId" type="string" required={true}>
505505
The unique identifier of a peer
506506
</Property>
507507
</Properties>
508508
509-
#### Request-Body Parameters
509+
### Request-Body Parameters
510510
511511
<Properties><Property name="name" type="string" required={true}>
512512
@@ -830,7 +830,7 @@ echo $response;
830830
<Col>
831831
Delete a peer
832832
833-
#### Path Parameters
833+
### Path Parameters
834834
<Properties>
835835
836836
<Property name="peerId" type="string" required={true}>
@@ -994,7 +994,7 @@ echo $response;
994994
<Col>
995995
Returns a list of peers that the specified peer can connect to within the network.
996996
997-
#### Path Parameters
997+
### Path Parameters
998998
<Properties>
999999
10001000
<Property name="peerId" type="string" required={true}>

0 commit comments

Comments
 (0)