From c8683cc7e23a8eafcda1da3dffdb64cbb919a570 Mon Sep 17 00:00:00 2001 From: Pascal Fischer <32096965+pascal-fischer@users.noreply.github.com> Date: Tue, 24 Dec 2024 11:12:09 +0100 Subject: [PATCH] Link Networks API (#265) * update side menu to link networks * change heading --- generator/templates/ApiTemplate.ts | 6 ++-- src/components/NavigationAPI.jsx | 3 +- src/pages/ipa/resources/accounts.mdx | 6 ++-- src/pages/ipa/resources/dns.mdx | 12 +++---- src/pages/ipa/resources/geo-locations.mdx | 2 +- src/pages/ipa/resources/groups.mdx | 10 +++--- src/pages/ipa/resources/networks.mdx | 38 +++++++++++----------- src/pages/ipa/resources/peers.mdx | 10 +++--- src/pages/ipa/resources/policies.mdx | 10 +++--- src/pages/ipa/resources/posture-checks.mdx | 10 +++--- src/pages/ipa/resources/routes.mdx | 10 +++--- src/pages/ipa/resources/setup-keys.mdx | 10 +++--- src/pages/ipa/resources/tokens.mdx | 10 +++--- src/pages/ipa/resources/users.mdx | 12 +++---- 14 files changed, 75 insertions(+), 74 deletions(-) diff --git a/generator/templates/ApiTemplate.ts b/generator/templates/ApiTemplate.ts index 51b905d2..298b7810 100644 --- a/generator/templates/ApiTemplate.ts +++ b/generator/templates/ApiTemplate.ts @@ -10,7 +10,7 @@ export const title = '<%- tag %>' <%- operation.description %> <% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'path').length > 0){ %> - #### Path Parameters + ### Path Parameters <% operation.parameters.filter((parameter) => parameter.in === 'path').forEach(function(parameter){ %> @@ -20,7 +20,7 @@ export const title = '<%- tag %>' <% }; -%> <% if(operation.parameters && operation.parameters.filter((parameter) => parameter.in === 'query').length > 0){ %> - #### Query Parameters + ### Query Parameters <% operation.parameters.filter((parameter) => parameter.in === 'query').forEach(function(parameter){ %> @@ -30,7 +30,7 @@ export const title = '<%- tag %>' <% }; -%> <% if(operation.requestBody && operation.requestBody["content"]["application/json"].schema.properties){ %> - #### Request-Body Parameters + ### Request-Body Parameters <% function renderProperties(properties, required = [], depth = 0) { diff --git a/src/components/NavigationAPI.jsx b/src/components/NavigationAPI.jsx index 1bb9b9d4..599c8b44 100644 --- a/src/components/NavigationAPI.jsx +++ b/src/components/NavigationAPI.jsx @@ -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' }, ], diff --git a/src/pages/ipa/resources/accounts.mdx b/src/pages/ipa/resources/accounts.mdx index 939352aa..fdbf1d8d 100644 --- a/src/pages/ipa/resources/accounts.mdx +++ b/src/pages/ipa/resources/accounts.mdx @@ -222,7 +222,7 @@ echo $response; Deletes an account and all its resources. Only account owners can delete accounts. - #### Path Parameters + ### Path Parameters @@ -386,7 +386,7 @@ echo $response; Update information about an account - #### Path Parameters + ### Path Parameters @@ -394,7 +394,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters diff --git a/src/pages/ipa/resources/dns.mdx b/src/pages/ipa/resources/dns.mdx index 15d4c6ef..1ec61e01 100644 --- a/src/pages/ipa/resources/dns.mdx +++ b/src/pages/ipa/resources/dns.mdx @@ -224,7 +224,7 @@ echo $response; Creates a Nameserver Group - #### Request-Body Parameters + ### Request-Body Parameters @@ -650,7 +650,7 @@ echo $response; Get information about a Nameserver Groups - #### Path Parameters + ### Path Parameters @@ -870,7 +870,7 @@ echo $response; Update/Replace a Nameserver Group - #### Path Parameters + ### Path Parameters @@ -878,7 +878,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -1304,7 +1304,7 @@ echo $response; Delete a Nameserver Group - #### Path Parameters + ### Path Parameters @@ -1652,7 +1652,7 @@ echo $response; Updates a DNS settings object - #### Request-Body Parameters + ### Request-Body Parameters diff --git a/src/pages/ipa/resources/geo-locations.mdx b/src/pages/ipa/resources/geo-locations.mdx index 07f6e0d4..df85cf80 100644 --- a/src/pages/ipa/resources/geo-locations.mdx +++ b/src/pages/ipa/resources/geo-locations.mdx @@ -184,7 +184,7 @@ echo $response; Get a list of all English city names for a given country code - #### Path Parameters + ### Path Parameters diff --git a/src/pages/ipa/resources/groups.mdx b/src/pages/ipa/resources/groups.mdx index cd7bcfd3..4d55ab07 100644 --- a/src/pages/ipa/resources/groups.mdx +++ b/src/pages/ipa/resources/groups.mdx @@ -220,7 +220,7 @@ echo $response; Creates a group - #### Request-Body Parameters + ### Request-Body Parameters @@ -556,7 +556,7 @@ echo $response; Get information about a group - #### Path Parameters + ### Path Parameters @@ -772,7 +772,7 @@ echo $response; Update/Replace a group - #### Path Parameters + ### Path Parameters @@ -780,7 +780,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -1116,7 +1116,7 @@ echo $response; Delete a group - #### Path Parameters + ### Path Parameters diff --git a/src/pages/ipa/resources/networks.mdx b/src/pages/ipa/resources/networks.mdx index da44e1be..25354599 100644 --- a/src/pages/ipa/resources/networks.mdx +++ b/src/pages/ipa/resources/networks.mdx @@ -212,7 +212,7 @@ echo $response; Creates a Network - #### Request-Body Parameters + ### Request-Body Parameters @@ -462,7 +462,7 @@ echo $response; Get information about a Network - #### Path Parameters + ### Path Parameters @@ -670,7 +670,7 @@ echo $response; Update/Replace a Network - #### Path Parameters + ### Path Parameters @@ -678,7 +678,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -928,7 +928,7 @@ echo $response; Delete a network - #### Path Parameters + ### Path Parameters @@ -1092,7 +1092,7 @@ echo $response; Returns a list of all resources in a network - #### Path Parameters + ### Path Parameters @@ -1306,7 +1306,7 @@ echo $response; Creates a Network Resource - #### Path Parameters + ### Path Parameters @@ -1314,7 +1314,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -1604,7 +1604,7 @@ echo $response; Get information about a Network Resource - #### Path Parameters + ### Path Parameters @@ -1818,7 +1818,7 @@ echo $response; Update a Network Resource - #### Path Parameters + ### Path Parameters @@ -1830,7 +1830,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -2120,7 +2120,7 @@ echo $response; Delete a network resource - #### Path Parameters + ### Path Parameters @@ -2288,7 +2288,7 @@ echo $response; Returns a list of all routers in a network - #### Path Parameters + ### Path Parameters @@ -2488,7 +2488,7 @@ echo $response; Creates a Network Router - #### Path Parameters + ### Path Parameters @@ -2496,7 +2496,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -2772,7 +2772,7 @@ echo $response; Get information about a Network Router - #### Path Parameters + ### Path Parameters @@ -2972,7 +2972,7 @@ echo $response; Update a Network Router - #### Path Parameters + ### Path Parameters @@ -2984,7 +2984,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -3260,7 +3260,7 @@ echo $response; Delete a network router - #### Path Parameters + ### Path Parameters diff --git a/src/pages/ipa/resources/peers.mdx b/src/pages/ipa/resources/peers.mdx index d735c035..07c8fe42 100644 --- a/src/pages/ipa/resources/peers.mdx +++ b/src/pages/ipa/resources/peers.mdx @@ -252,7 +252,7 @@ echo $response; Get information about a peer - #### Path Parameters + ### Path Parameters @@ -498,7 +498,7 @@ echo $response; Update information about a peer - #### Path Parameters + ### Path Parameters @@ -506,7 +506,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -830,7 +830,7 @@ echo $response; Delete a peer - #### Path Parameters + ### Path Parameters @@ -994,7 +994,7 @@ echo $response; Returns a list of peers that the specified peer can connect to within the network. - #### Path Parameters + ### Path Parameters diff --git a/src/pages/ipa/resources/policies.mdx b/src/pages/ipa/resources/policies.mdx index 72369971..c47a054a 100644 --- a/src/pages/ipa/resources/policies.mdx +++ b/src/pages/ipa/resources/policies.mdx @@ -292,7 +292,7 @@ echo $response; Creates a policy - #### Request-Body Parameters + ### Request-Body Parameters @@ -1038,7 +1038,7 @@ echo $response; Get information about a Policies - #### Path Parameters + ### Path Parameters @@ -1326,7 +1326,7 @@ echo $response; Update/Replace a Policy - #### Path Parameters + ### Path Parameters @@ -1334,7 +1334,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -2080,7 +2080,7 @@ echo $response; Delete a policy - #### Path Parameters + ### Path Parameters diff --git a/src/pages/ipa/resources/posture-checks.mdx b/src/pages/ipa/resources/posture-checks.mdx index 6111e037..e6be9765 100644 --- a/src/pages/ipa/resources/posture-checks.mdx +++ b/src/pages/ipa/resources/posture-checks.mdx @@ -286,7 +286,7 @@ echo $response; Creates a posture check - #### Request-Body Parameters + ### Request-Body Parameters @@ -1172,7 +1172,7 @@ echo $response; Get information about a posture check - #### Path Parameters + ### Path Parameters @@ -1454,7 +1454,7 @@ echo $response; Update/Replace a posture check - #### Path Parameters + ### Path Parameters @@ -1462,7 +1462,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -2348,7 +2348,7 @@ echo $response; Delete a posture check - #### Path Parameters + ### Path Parameters diff --git a/src/pages/ipa/resources/routes.mdx b/src/pages/ipa/resources/routes.mdx index a045389f..cfc01679 100644 --- a/src/pages/ipa/resources/routes.mdx +++ b/src/pages/ipa/resources/routes.mdx @@ -230,7 +230,7 @@ echo $response; Creates a Route - #### Request-Body Parameters + ### Request-Body Parameters @@ -674,7 +674,7 @@ echo $response; Get information about a Routes - #### Path Parameters + ### Path Parameters @@ -900,7 +900,7 @@ echo $response; Update/Replace a Route - #### Path Parameters + ### Path Parameters @@ -908,7 +908,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -1352,7 +1352,7 @@ echo $response; Delete a route - #### Path Parameters + ### Path Parameters diff --git a/src/pages/ipa/resources/setup-keys.mdx b/src/pages/ipa/resources/setup-keys.mdx index ad59a1db..466d6066 100644 --- a/src/pages/ipa/resources/setup-keys.mdx +++ b/src/pages/ipa/resources/setup-keys.mdx @@ -218,7 +218,7 @@ echo $response; Creates a setup key - #### Request-Body Parameters + ### Request-Body Parameters @@ -536,7 +536,7 @@ echo $response; Get information about a setup key - #### Path Parameters + ### Path Parameters @@ -750,7 +750,7 @@ echo $response; Update information about a setup key - #### Path Parameters + ### Path Parameters @@ -758,7 +758,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -1028,7 +1028,7 @@ echo $response; Delete a Setup Key - #### Path Parameters + ### Path Parameters diff --git a/src/pages/ipa/resources/tokens.mdx b/src/pages/ipa/resources/tokens.mdx index 6e0f7b5f..0cc0ed3e 100644 --- a/src/pages/ipa/resources/tokens.mdx +++ b/src/pages/ipa/resources/tokens.mdx @@ -8,7 +8,7 @@ export const title = 'Tokens' Returns a list of all tokens for a user - #### Path Parameters + ### Path Parameters @@ -206,7 +206,7 @@ echo $response; Create a new token for a user - #### Path Parameters + ### Path Parameters @@ -214,7 +214,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -456,7 +456,7 @@ echo $response; Returns a specific token for a user - #### Path Parameters + ### Path Parameters @@ -654,7 +654,7 @@ echo $response; Delete a token for a user - #### Path Parameters + ### Path Parameters diff --git a/src/pages/ipa/resources/users.mdx b/src/pages/ipa/resources/users.mdx index a970a3c0..4dc45ef5 100644 --- a/src/pages/ipa/resources/users.mdx +++ b/src/pages/ipa/resources/users.mdx @@ -8,7 +8,7 @@ export const title = 'Users' Returns a list of all users - #### Query Parameters + ### Query Parameters @@ -226,7 +226,7 @@ echo $response; Creates a new service user or sends an invite to a regular user - #### Request-Body Parameters + ### Request-Body Parameters @@ -532,7 +532,7 @@ echo $response; Update information about a User - #### Path Parameters + ### Path Parameters @@ -540,7 +540,7 @@ echo $response; - #### Request-Body Parameters + ### Request-Body Parameters @@ -822,7 +822,7 @@ echo $response; 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 @@ -986,7 +986,7 @@ echo $response; Resend user invitation - #### Path Parameters + ### Path Parameters