Update API pages with v0.25.4

2026-04-16 15:36:36 +00:00 · 2024-01-16 09:16:37 +00:00
parent e6ee8ec034
commit c1aa6739df
11 changed files with 53 additions and 53 deletions
--- a/src/pages/ipa/resources/accounts.mdx
+++ b/src/pages/ipa/resources/accounts.mdx
@@ -2,7 +2,7 @@ export const title = 'Accounts'



-## List all Accounts {{ tag: 'GET' , label: '/api/accounts' }}
+## List all Accounts {{ tag: 'GET' , label: '/api/accounts' }} 

 <Row>
  <Col>
@@ -212,7 +212,7 @@ echo $response;
 ---


-## Update an Account {{ tag: 'PUT' , label: '/api/accounts/{accountId}' }}
+## Update an Account {{ tag: 'PUT' , label: '/api/accounts/{accountId}' }} 

 <Row>
  <Col>
@@ -590,7 +590,7 @@ echo $response;
 ---


-## Delete an Account {{ tag: 'DELETE' , label: '/api/accounts/{accountId}' }}
+## Delete an Account {{ tag: 'DELETE' , label: '/api/accounts/{accountId}' }} 

 <Row>
  <Col>
--- a/src/pages/ipa/resources/dns.mdx
+++ b/src/pages/ipa/resources/dns.mdx
@@ -2,7 +2,7 @@ export const title = 'DNS'



-## List all Nameserver Groups {{ tag: 'GET' , label: '/api/dns/nameservers' }}
+## List all Nameserver Groups {{ tag: 'GET' , label: '/api/dns/nameservers' }} 

 <Row>
  <Col>
@@ -222,7 +222,7 @@ echo $response;
 ---


-## Create a Nameserver Group {{ tag: 'POST' , label: '/api/dns/nameservers' }}
+## Create a Nameserver Group {{ tag: 'POST' , label: '/api/dns/nameservers' }} 

 <Row>
  <Col>
@@ -652,7 +652,7 @@ echo $response;
 ---


-## Retrieve a Nameserver Group {{ tag: 'GET' , label: '/api/dns/nameservers/{nsgroupId}' }}
+## Retrieve a Nameserver Group {{ tag: 'GET' , label: '/api/dns/nameservers/{nsgroupId}' }} 

 <Row>
  <Col>
@@ -876,7 +876,7 @@ echo $response;
 ---


-## Update a Nameserver Group {{ tag: 'PUT' , label: '/api/dns/nameservers/{nsgroupId}' }}
+## Update a Nameserver Group {{ tag: 'PUT' , label: '/api/dns/nameservers/{nsgroupId}' }} 

 <Row>
  <Col>
@@ -1314,7 +1314,7 @@ echo $response;
 ---


-## Delete a Nameserver Group {{ tag: 'DELETE' , label: '/api/dns/nameservers/{nsgroupId}' }}
+## Delete a Nameserver Group {{ tag: 'DELETE' , label: '/api/dns/nameservers/{nsgroupId}' }} 

 <Row>
  <Col>
@@ -1480,7 +1480,7 @@ echo $response;
 ---


-## Retrieve DNS settings {{ tag: 'GET' , label: '/api/dns/settings' }}
+## Retrieve DNS settings {{ tag: 'GET' , label: '/api/dns/settings' }} 

 <Row>
  <Col>
@@ -1668,7 +1668,7 @@ echo $response;
 ---


-## Update DNS Settings {{ tag: 'PUT' , label: '/api/dns/settings' }}
+## Update DNS Settings {{ tag: 'PUT' , label: '/api/dns/settings' }} 

 <Row>
  <Col>
--- a/src/pages/ipa/resources/events.mdx
+++ b/src/pages/ipa/resources/events.mdx
@@ -2,7 +2,7 @@ export const title = 'Events'



-## List all Events {{ tag: 'GET' , label: '/api/events' }}
+## List all Events {{ tag: 'GET' , label: '/api/events' }} 

 <Row>
  <Col>
--- a/src/pages/ipa/resources/groups.mdx
+++ b/src/pages/ipa/resources/groups.mdx
@@ -2,7 +2,7 @@ export const title = 'Groups'



-## List all Groups {{ tag: 'GET' , label: '/api/groups' }}
+## List all Groups {{ tag: 'GET' , label: '/api/groups' }} 

 <Row>
  <Col>
@@ -204,7 +204,7 @@ echo $response;
 ---


-## Create a Group {{ tag: 'POST' , label: '/api/groups' }}
+## Create a Group {{ tag: 'POST' , label: '/api/groups' }} 

 <Row>
  <Col>
@@ -468,7 +468,7 @@ echo $response;
 ---


-## Retrieve a Group {{ tag: 'GET' , label: '/api/groups/{groupId}' }}
+## Retrieve a Group {{ tag: 'GET' , label: '/api/groups/{groupId}' }} 

 <Row>
  <Col>
@@ -674,7 +674,7 @@ echo $response;
 ---


-## Update a Group {{ tag: 'PUT' , label: '/api/groups/{groupId}' }}
+## Update a Group {{ tag: 'PUT' , label: '/api/groups/{groupId}' }} 

 <Row>
  <Col>
@@ -946,7 +946,7 @@ echo $response;
 ---


-## Delete a Group {{ tag: 'DELETE' , label: '/api/groups/{groupId}' }}
+## Delete a Group {{ tag: 'DELETE' , label: '/api/groups/{groupId}' }} 

 <Row>
  <Col>
--- a/src/pages/ipa/resources/peers.mdx
+++ b/src/pages/ipa/resources/peers.mdx
@@ -2,7 +2,7 @@ export const title = 'Peers'



-## List all Peers {{ tag: 'GET' , label: '/api/peers' }}
+## List all Peers {{ tag: 'GET' , label: '/api/peers' }} 

 <Row>
  <Col>
@@ -234,7 +234,7 @@ echo $response;
 ---


-## Retrieve a Peer {{ tag: 'GET' , label: '/api/peers/{peerId}' }}
+## Retrieve a Peer {{ tag: 'GET' , label: '/api/peers/{peerId}' }} 

 <Row>
  <Col>
@@ -486,7 +486,7 @@ echo $response;
 ---


-## Update a Peer {{ tag: 'PUT' , label: '/api/peers/{peerId}' }}
+## Update a Peer {{ tag: 'PUT' , label: '/api/peers/{peerId}' }} 

 <Row>
  <Col>
@@ -818,7 +818,7 @@ echo $response;
 ---


-## Delete a Peer {{ tag: 'DELETE' , label: '/api/peers/{peerId}' }}
+## Delete a Peer {{ tag: 'DELETE' , label: '/api/peers/{peerId}' }} 

 <Row>
  <Col>
--- a/src/pages/ipa/resources/policies.mdx
+++ b/src/pages/ipa/resources/policies.mdx
@@ -2,7 +2,7 @@ export const title = 'Policies'



-## List all Policies {{ tag: 'GET' , label: '/api/policies' }}
+## List all Policies {{ tag: 'GET' , label: '/api/policies' }} 

 <Row>
  <Col>
@@ -254,7 +254,7 @@ echo $response;
 ---


-## Create a Policy {{ tag: 'POST' , label: '/api/policies' }}
+## Create a Policy {{ tag: 'POST' , label: '/api/policies' }} 

 <Row>
  <Col>
@@ -739,7 +739,7 @@ echo $response;
 ---


-## Retrieve a Policy {{ tag: 'GET' , label: '/api/policies/{policyId}' }}
+## Retrieve a Policy {{ tag: 'GET' , label: '/api/policies/{policyId}' }} 

 <Row>
  <Col>
@@ -995,7 +995,7 @@ echo $response;
 ---


-## Update a Policy {{ tag: 'PUT' , label: '/api/policies/{policyId}' }}
+## Update a Policy {{ tag: 'PUT' , label: '/api/policies/{policyId}' }} 

 <Row>
  <Col>
@@ -1492,7 +1492,7 @@ echo $response;
 ---


-## Delete a Policy {{ tag: 'DELETE' , label: '/api/policies/{policyId}' }}
+## Delete a Policy {{ tag: 'DELETE' , label: '/api/policies/{policyId}' }} 

 <Row>
  <Col>
--- a/src/pages/ipa/resources/routes.mdx
+++ b/src/pages/ipa/resources/routes.mdx
@@ -2,7 +2,7 @@ export const title = 'Routes'



-## List all Routes {{ tag: 'GET' , label: '/api/routes' }}
+## List all Routes {{ tag: 'GET' , label: '/api/routes' }} 

 <Row>
  <Col>
@@ -214,7 +214,7 @@ echo $response;
 ---


-## Create a Route {{ tag: 'POST' , label: '/api/routes' }}
+## Create a Route {{ tag: 'POST' , label: '/api/routes' }} 

 <Row>
  <Col>
@@ -608,7 +608,7 @@ echo $response;
 ---


-## Retrieve a Route {{ tag: 'GET' , label: '/api/routes/{routeId}' }}
+## Retrieve a Route {{ tag: 'GET' , label: '/api/routes/{routeId}' }} 

 <Row>
  <Col>
@@ -824,7 +824,7 @@ echo $response;
 ---


-## Update a Route {{ tag: 'PUT' , label: '/api/routes/{routeId}' }}
+## Update a Route {{ tag: 'PUT' , label: '/api/routes/{routeId}' }} 

 <Row>
  <Col>
@@ -1226,7 +1226,7 @@ echo $response;
 ---


-## Delete a Route {{ tag: 'DELETE' , label: '/api/routes/{routeId}' }}
+## Delete a Route {{ tag: 'DELETE' , label: '/api/routes/{routeId}' }} 

 <Row>
  <Col>
--- a/src/pages/ipa/resources/rules.mdx
+++ b/src/pages/ipa/resources/rules.mdx
@@ -2,11 +2,11 @@ export const title = 'Rules'



-## List all Rules {{ tag: 'GET' , label: '/api/rules' }}
+## List all Rules {{ tag: 'GET' , label: '/api/rules' }} <Badge status="warning" text="Deprecated" />

 <Row>
  <Col>
-    Returns a list of all rules
+    Returns a list of all rules. This will be deprecated in favour of `/api/policies`.
              </Col>

  <Col sticky>
@@ -226,11 +226,11 @@ echo $response;
 ---


-## Create a Rule {{ tag: 'POST' , label: '/api/rules' }}
+## Create a Rule {{ tag: 'POST' , label: '/api/rules' }} <Badge status="warning" text="Deprecated" />

 <Row>
  <Col>
-    Creates a rule
+    Creates a rule. This will be deprecated in favour of `/api/policies`.
            
    #### Request-Body Parameters
    <Properties>
@@ -578,11 +578,11 @@ echo $response;
 ---


-## Retrieve a Rule {{ tag: 'GET' , label: '/api/rules/{ruleId}' }}
+## Retrieve a Rule {{ tag: 'GET' , label: '/api/rules/{ruleId}' }} <Badge status="warning" text="Deprecated" />

 <Row>
  <Col>
-    Get information about a rules
+    Get information about a rules. This will be deprecated in favour of `/api/policies/{policyID}`.
    
    #### Path Parameters
    <Properties>
@@ -806,11 +806,11 @@ echo $response;
 ---


-## Update a Rule {{ tag: 'PUT' , label: '/api/rules/{ruleId}' }}
+## Update a Rule {{ tag: 'PUT' , label: '/api/rules/{ruleId}' }} <Badge status="warning" text="Deprecated" />

 <Row>
  <Col>
-    Update/Replace a rule
+    Update/Replace a rule. This will be deprecated in favour of `/api/policies/{policyID}`.
    
    #### Path Parameters
    <Properties>
@@ -1170,11 +1170,11 @@ echo $response;
 ---


-## Delete a Rule {{ tag: 'DELETE' , label: '/api/rules/{ruleId}' }}
+## Delete a Rule {{ tag: 'DELETE' , label: '/api/rules/{ruleId}' }} <Badge status="warning" text="Deprecated" />

 <Row>
  <Col>
-    Delete a rule
+    Delete a rule. This will be deprecated in favour of `/api/policies/{policyID}`.
    
    #### Path Parameters
    <Properties>
--- a/src/pages/ipa/resources/setup-keys.mdx
+++ b/src/pages/ipa/resources/setup-keys.mdx
@@ -2,7 +2,7 @@ export const title = 'Setup Keys'



-## List all Setup Keys {{ tag: 'GET' , label: '/api/setup-keys' }}
+## List all Setup Keys {{ tag: 'GET' , label: '/api/setup-keys' }} 

 <Row>
  <Col>
@@ -216,7 +216,7 @@ echo $response;
 ---


-## Create a Setup Key {{ tag: 'POST' , label: '/api/setup-keys' }}
+## Create a Setup Key {{ tag: 'POST' , label: '/api/setup-keys' }} 

 <Row>
  <Col>
@@ -566,7 +566,7 @@ echo $response;
 ---


-## Retrieve a Setup Key {{ tag: 'GET' , label: '/api/setup-keys/{keyId}' }}
+## Retrieve a Setup Key {{ tag: 'GET' , label: '/api/setup-keys/{keyId}' }} 

 <Row>
  <Col>
@@ -784,7 +784,7 @@ echo $response;
 ---


-## Update a Setup Key {{ tag: 'PUT' , label: '/api/setup-keys/{keyId}' }}
+## Update a Setup Key {{ tag: 'PUT' , label: '/api/setup-keys/{keyId}' }} 

 <Row>
  <Col>
--- a/src/pages/ipa/resources/tokens.mdx
+++ b/src/pages/ipa/resources/tokens.mdx
@@ -2,7 +2,7 @@ export const title = 'Tokens'



-## List all Tokens {{ tag: 'GET' , label: '/api/users/{userId}/tokens' }}
+## List all Tokens {{ tag: 'GET' , label: '/api/users/{userId}/tokens' }} 

 <Row>
  <Col>
@@ -204,7 +204,7 @@ echo $response;
 ---


-## Create a Token {{ tag: 'POST' , label: '/api/users/{userId}/tokens' }}
+## Create a Token {{ tag: 'POST' , label: '/api/users/{userId}/tokens' }} 

 <Row>
  <Col>
@@ -464,7 +464,7 @@ echo $response;
 ---


-## Retrieve a Token {{ tag: 'GET' , label: '/api/users/{userId}/tokens/{tokenId}' }}
+## Retrieve a Token {{ tag: 'GET' , label: '/api/users/{userId}/tokens/{tokenId}' }} 

 <Row>
  <Col>
@@ -666,7 +666,7 @@ echo $response;
 ---


-## Delete a Token {{ tag: 'DELETE' , label: '/api/users/{userId}/tokens/{tokenId}' }}
+## Delete a Token {{ tag: 'DELETE' , label: '/api/users/{userId}/tokens/{tokenId}' }} 

 <Row>
  <Col>
--- a/src/pages/ipa/resources/users.mdx
+++ b/src/pages/ipa/resources/users.mdx
@@ -2,7 +2,7 @@ export const title = 'Users'



-## List all Users {{ tag: 'GET' , label: '/api/users' }}
+## List all Users {{ tag: 'GET' , label: '/api/users' }} 

 <Row>
  <Col>
@@ -218,7 +218,7 @@ echo $response;
 ---


-## Create a User {{ tag: 'POST' , label: '/api/users' }}
+## Create a User {{ tag: 'POST' , label: '/api/users' }} 

 <Row>
  <Col>
@@ -530,7 +530,7 @@ echo $response;
 ---


-## Update a User {{ tag: 'PUT' , label: '/api/users/{userId}' }}
+## Update a User {{ tag: 'PUT' , label: '/api/users/{userId}' }} 

 <Row>
  <Col>
@@ -822,7 +822,7 @@ echo $response;
 ---


-## Delete a User {{ tag: 'DELETE' , label: '/api/users/{userId}' }}
+## Delete a User {{ tag: 'DELETE' , label: '/api/users/{userId}' }} 

 <Row>
  <Col>
@@ -988,7 +988,7 @@ echo $response;
 ---


-## Resend user invitation {{ tag: 'POST' , label: '/api/users/{userId}/invite' }}
+## Resend user invitation {{ tag: 'POST' , label: '/api/users/{userId}/invite' }} 

 <Row>
  <Col>