From 8790af1e0eb49d1362465de3bbe72d7ad34b2b35 Mon Sep 17 00:00:00 2001
From: "C.K." <98986935+some-ci@users.noreply.github.com>
Date: Thu, 5 Dec 2024 09:10:11 -0800
Subject: [PATCH] chore: update edge documentation (#241)
---
docs/reference/api/load-time-series-data.api.mdx | 2 +-
docs/reference/unified-data-model/base/index.mdx | 4 ++--
.../unified-data-model/base/phantom_resource.mdx | 4 ++++
docs/reference/unified-data-model/base/resource.mdx | 1 +
.../gcp/compute/gcp_notification_endpoint.mdx | 10 ++++++++++
static/img/kroki/3e5c2e5f1a13d61edd3da3cf2c8e1a8c.svg | 1 +
static/img/kroki/6de2043f00b6b3f68fc9d753b56b6c85.svg | 1 +
static/img/kroki/b3c2cb42502512623f0c664dfe856918.svg | 1 +
static/img/kroki/f6bb40b407513c1eb9dc66969b150547.svg | 1 +
.../reference/api/load-time-series-data.api.mdx | 2 +-
10 files changed, 23 insertions(+), 4 deletions(-)
create mode 100644 static/img/kroki/3e5c2e5f1a13d61edd3da3cf2c8e1a8c.svg
create mode 100644 static/img/kroki/6de2043f00b6b3f68fc9d753b56b6c85.svg
create mode 100644 static/img/kroki/b3c2cb42502512623f0c664dfe856918.svg
create mode 100644 static/img/kroki/f6bb40b407513c1eb9dc66969b150547.svg
diff --git a/docs/reference/api/load-time-series-data.api.mdx b/docs/reference/api/load-time-series-data.api.mdx
index 51579b46..e94676fa 100644
--- a/docs/reference/api/load-time-series-data.api.mdx
+++ b/docs/reference/api/load-time-series-data.api.mdx
@@ -5,7 +5,7 @@ description: "Load time series data."
sidebar_label: "Load time series data."
hide_title: true
hide_table_of_contents: true
-api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-05T15:39:08.606Z","end":"2024-12-05T15:39:08.606Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
+api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-05T16:52:09.277Z","end":"2024-12-05T16:52:09.277Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "post api-method"
info_path: reference/api/fix-inventory-core-rest-api
custom_edit_url: null
diff --git a/docs/reference/unified-data-model/base/index.mdx b/docs/reference/unified-data-model/base/index.mdx
index 8516577a..89ad4972 100644
--- a/docs/reference/unified-data-model/base/index.mdx
+++ b/docs/reference/unified-data-model/base/index.mdx
@@ -16,8 +16,8 @@ sidebar_position: 1
- [Bucket Quota](bucket_quota.mdx)
- [Certificate](certificate.mdx)
- [Certificate Quota](certificate_quota.mdx)
-- [Cloud](cloud.mdx)
- [Cloud](base_cloud.mdx)
+- [Cloud](cloud.mdx)
- [DNS Record](dns_record.mdx)
- [DNS Record Set](dns_record_set.mdx)
- [DNS Zone](dns_zone.mdx)
@@ -123,8 +123,8 @@ sidebar_position: 1
- [Account](account.mdx)
- [Auto Scaling Group](autoscaling_group.mdx)
-- [Cloud](cloud.mdx)
- [Cloud](base_cloud.mdx)
+- [Cloud](cloud.mdx)
- [Managed Kubernetes Cluster Provider](managed_kubernetes_cluster_provider.mdx)
- [Organizational Root](organizational_root.mdx)
- [Organizational Unit](organizational_unit.mdx)
diff --git a/docs/reference/unified-data-model/base/phantom_resource.mdx b/docs/reference/unified-data-model/base/phantom_resource.mdx
index 1629d38c..e8a32ec2 100644
--- a/docs/reference/unified-data-model/base/phantom_resource.mdx
+++ b/docs/reference/unified-data-model/base/phantom_resource.mdx
@@ -160,6 +160,9 @@ class gcp_interconnect_location {
}
class gcp_machine_type {
+}
+class gcp_notification_endpoint {
+
}
class gcp_region {
@@ -272,6 +275,7 @@ quota <|--- gateway_quota
volume_type <|--- gcp_disk_type
phantom_resource <|--- gcp_interconnect_location
instance_type <|--- gcp_machine_type
+phantom_resource <|--- gcp_notification_endpoint
region <|--- gcp_region
phantom_resource <|--- gcp_region_quota
zone <|--- gcp_zone
diff --git a/docs/reference/unified-data-model/base/resource.mdx b/docs/reference/unified-data-model/base/resource.mdx
index 694eb0a6..19aea4b8 100644
--- a/docs/reference/unified-data-model/base/resource.mdx
+++ b/docs/reference/unified-data-model/base/resource.mdx
@@ -2754,6 +2754,7 @@ gcp_resource <|--- gcp_node_group
gcp_resource <|--- gcp_node_template
gcp_resource <|--- gcp_node_type
gcp_resource <|--- gcp_notification_endpoint
+phantom_resource <|--- gcp_notification_endpoint
gcp_resource <|--- gcp_object
gcp_resource <|--- gcp_operation
gcp_resource <|--- gcp_packet_mirroring
diff --git a/docs/reference/unified-data-model/gcp/compute/gcp_notification_endpoint.mdx b/docs/reference/unified-data-model/gcp/compute/gcp_notification_endpoint.mdx
index dc476b98..0e54cc40 100644
--- a/docs/reference/unified-data-model/gcp/compute/gcp_notification_endpoint.mdx
+++ b/docs/reference/unified-data-model/gcp/compute/gcp_notification_endpoint.mdx
@@ -45,12 +45,17 @@ class gcp_notification_endpoint {
}
class gcp_resource {
+}
+class phantom_resource {
+
}
class resource {
}
gcp_resource <|--- gcp_notification_endpoint
+phantom_resource <|--- gcp_notification_endpoint
resource <|--- gcp_resource
+resource <|--- phantom_resource
@enduml
```
@@ -148,6 +153,9 @@ class gcp_resource {
**description**: string
**label_fingerprint**: string
**link**: string
+}
+class phantom_resource {
+
}
class resource {
**age**: duration
@@ -164,9 +172,11 @@ class resource {
gcp_notification_endpoint --> gcp_deprecation_status
gcp_notification_endpoint --> gcp_notification_endpoint_grpc_settings
gcp_resource <|--- gcp_notification_endpoint
+phantom_resource <|--- gcp_notification_endpoint
gcp_notification_endpoint_grpc_settings --> gcp_duration
gcp_resource --> gcp_deprecation_status
resource <|--- gcp_resource
+resource <|--- phantom_resource
@enduml
```
diff --git a/static/img/kroki/3e5c2e5f1a13d61edd3da3cf2c8e1a8c.svg b/static/img/kroki/3e5c2e5f1a13d61edd3da3cf2c8e1a8c.svg
new file mode 100644
index 00000000..610cd363
--- /dev/null
+++ b/static/img/kroki/3e5c2e5f1a13d61edd3da3cf2c8e1a8c.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/static/img/kroki/6de2043f00b6b3f68fc9d753b56b6c85.svg b/static/img/kroki/6de2043f00b6b3f68fc9d753b56b6c85.svg
new file mode 100644
index 00000000..18ff11e6
--- /dev/null
+++ b/static/img/kroki/6de2043f00b6b3f68fc9d753b56b6c85.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/static/img/kroki/b3c2cb42502512623f0c664dfe856918.svg b/static/img/kroki/b3c2cb42502512623f0c664dfe856918.svg
new file mode 100644
index 00000000..c6a3c201
--- /dev/null
+++ b/static/img/kroki/b3c2cb42502512623f0c664dfe856918.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/static/img/kroki/f6bb40b407513c1eb9dc66969b150547.svg b/static/img/kroki/f6bb40b407513c1eb9dc66969b150547.svg
new file mode 100644
index 00000000..cee9821d
--- /dev/null
+++ b/static/img/kroki/f6bb40b407513c1eb9dc66969b150547.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx b/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx
index 75ad8049..c2d76501 100644
--- a/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx
+++ b/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx
@@ -5,7 +5,7 @@ description: "Load time series data."
sidebar_label: "Load time series data."
hide_title: true
hide_table_of_contents: true
-api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-05T15:39:08.958Z","end":"2024-12-05T15:39:08.958Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
+api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-05T16:52:09.633Z","end":"2024-12-05T16:52:09.633Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "post api-method"
info_path: version-4.X/reference/api/fix-inventory-core-rest-api
custom_edit_url: null