Update API pages with v0.26.3

netbirdio · Mar 12, 2024 · 126bc96 · 126bc96
1 parent da6d580
commit 126bc96
Show file tree

Hide file tree

Showing 13 changed files with 338 additions and 5,153 deletions.
diff --git a/src/pages/ipa/resources/accounts.mdx b/src/pages/ipa/resources/accounts.mdx
diff --git a/src/pages/ipa/resources/dns.mdx b/src/pages/ipa/resources/dns.mdx
diff --git a/src/pages/ipa/resources/events.mdx b/src/pages/ipa/resources/events.mdx
@@ -160,47 +160,18 @@ echo $response;
     
     <CodeGroup title="Response">
 ```json {{ title: 'Example' }}
-[
-  {
-    "id": 10,
-    "timestamp": "2023-05-05T10:04:37.473542Z",
-    "activity": "Route created",
-    "activity_code": "route.add",
-    "initiator_id": "google-oauth2|123456789012345678901",
-    "initiator_name": "John Doe",
-    "initiator_email": "[email protected]",
-    "target_id": "chad9d86lnnc59g18ou0",
-    "meta": {
-      "name": "my route",
-      "network_range": "10.64.0.0/24",
-      "peer_id": "chacbco6lnnbn6cg5s91"
-    }
+{
+  "items": {
+    "$ref": "#/components/schemas/Event"
   }
-]
+}
 ```
 ```json {{ title: 'Schema' }}
-[
-  {
-    "id": "string",
-    "timestamp": "string",
-    "activity": "string",
-    "activity_code": "string",
-    "initiator_id": "string",
-    "initiator_name": "string",
-    "initiator_email": "string",
-    "target_id": "string",
-    "meta": {
-      "description": "The metadata of the event",
-      "type": "object",
-      "additionalProperties": "string",
-      "example": {
-        "name": "my route",
-        "network_range": "10.64.0.0/24",
-        "peer_id": "chacbco6lnnbn6cg5s91"
-      }
-    }
+{
+  "items": {
+    "$ref": "#/components/schemas/Event"
   }
-]
+}
 ```
     </CodeGroup>
     

diff --git a/src/pages/ipa/resources/geo-locations.mdx b/src/pages/ipa/resources/geo-locations.mdx
@@ -2,7 +2,7 @@ export const title = 'Geo Locations'
 
 
 
-## List all country codes {{ tag: 'GET' , label: '/api/locations/countries' }}
+## List all country codes {{ tag: 'GET' , label: '/api/locations/countries' }} 
 
 <Row>
   <Col>
@@ -160,14 +160,16 @@ echo $response;
     
     <CodeGroup title="Response">
 ```json {{ title: 'Example' }}
-[
-  "DE"
-]
+{
+  "items": "DE"
+}
 ```
 ```json {{ title: 'Schema' }}
-[
-  "string"
-]
+{
+  "items": {
+    "example": "DE"
+  }
+}
 ```
     </CodeGroup>
     
@@ -178,7 +180,7 @@ echo $response;
 ---
 
 
-## List all city names by country {{ tag: 'GET' , label: '/api/locations/countries/{country}/cities' }}
+## List all city names by country {{ tag: 'GET' , label: '/api/locations/countries/{country}/cities' }} 
 
 <Row>
   <Col>
@@ -345,14 +347,12 @@ echo $response;
     <CodeGroup title="Response">
 ```json {{ title: 'Example' }}
 {
-  "geoname_id": 2950158,
-  "city_name": "Berlin"
+  "$ref": "#/components/schemas/City"
 }
 ```
 ```json {{ title: 'Schema' }}
 {
-  "geoname_id": "integer",
-  "city_name": "string"
+  "$ref": "#/components/schemas/City"
 }
 ```
     </CodeGroup>