Skip to content

Commit 8790af1

Browse files
authored
chore: update edge documentation (#241)
1 parent a8a1e32 commit 8790af1

File tree

10 files changed

+23
-4
lines changed

10 files changed

+23
-4
lines changed

docs/reference/api/load-time-series-data.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Load time series data."
55
sidebar_label: "Load time series data."
66
hide_title: true
77
hide_table_of_contents: true
8-
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"}}}}}
8+
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"}}}}}
99
sidebar_class_name: "post api-method"
1010
info_path: reference/api/fix-inventory-core-rest-api
1111
custom_edit_url: null

docs/reference/unified-data-model/base/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ sidebar_position: 1
1616
- [Bucket Quota](bucket_quota.mdx)
1717
- [Certificate](certificate.mdx)
1818
- [Certificate Quota](certificate_quota.mdx)
19-
- [Cloud](cloud.mdx)
2019
- [Cloud](base_cloud.mdx)
20+
- [Cloud](cloud.mdx)
2121
- [DNS Record](dns_record.mdx)
2222
- [DNS Record Set](dns_record_set.mdx)
2323
- [DNS Zone](dns_zone.mdx)
@@ -123,8 +123,8 @@ sidebar_position: 1
123123

124124
- [Account](account.mdx)
125125
- [Auto Scaling Group](autoscaling_group.mdx)
126-
- [Cloud](cloud.mdx)
127126
- [Cloud](base_cloud.mdx)
127+
- [Cloud](cloud.mdx)
128128
- [Managed Kubernetes Cluster Provider](managed_kubernetes_cluster_provider.mdx)
129129
- [Organizational Root](organizational_root.mdx)
130130
- [Organizational Unit](organizational_unit.mdx)

docs/reference/unified-data-model/base/phantom_resource.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,9 @@ class gcp_interconnect_location {
160160
}
161161
class gcp_machine_type {
162162
163+
}
164+
class gcp_notification_endpoint {
165+
163166
}
164167
class gcp_region {
165168
@@ -272,6 +275,7 @@ quota <|--- gateway_quota
272275
volume_type <|--- gcp_disk_type
273276
phantom_resource <|--- gcp_interconnect_location
274277
instance_type <|--- gcp_machine_type
278+
phantom_resource <|--- gcp_notification_endpoint
275279
region <|--- gcp_region
276280
phantom_resource <|--- gcp_region_quota
277281
zone <|--- gcp_zone

docs/reference/unified-data-model/base/resource.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2754,6 +2754,7 @@ gcp_resource <|--- gcp_node_group
27542754
gcp_resource <|--- gcp_node_template
27552755
gcp_resource <|--- gcp_node_type
27562756
gcp_resource <|--- gcp_notification_endpoint
2757+
phantom_resource <|--- gcp_notification_endpoint
27572758
gcp_resource <|--- gcp_object
27582759
gcp_resource <|--- gcp_operation
27592760
gcp_resource <|--- gcp_packet_mirroring

docs/reference/unified-data-model/gcp/compute/gcp_notification_endpoint.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,17 @@ class gcp_notification_endpoint {
4545
}
4646
class gcp_resource {
4747
48+
}
49+
class phantom_resource {
50+
4851
}
4952
class resource {
5053
5154
}
5255
gcp_resource <|--- gcp_notification_endpoint
56+
phantom_resource <|--- gcp_notification_endpoint
5357
resource <|--- gcp_resource
58+
resource <|--- phantom_resource
5459
5560
@enduml
5661
```
@@ -148,6 +153,9 @@ class gcp_resource {
148153
**description**: string
149154
**label_fingerprint**: string
150155
**link**: string
156+
}
157+
class phantom_resource {
158+
151159
}
152160
class resource {
153161
**age**: duration
@@ -164,9 +172,11 @@ class resource {
164172
gcp_notification_endpoint --> gcp_deprecation_status
165173
gcp_notification_endpoint --> gcp_notification_endpoint_grpc_settings
166174
gcp_resource <|--- gcp_notification_endpoint
175+
phantom_resource <|--- gcp_notification_endpoint
167176
gcp_notification_endpoint_grpc_settings --> gcp_duration
168177
gcp_resource --> gcp_deprecation_status
169178
resource <|--- gcp_resource
179+
resource <|--- phantom_resource
170180
171181
@enduml
172182
```

static/img/kroki/3e5c2e5f1a13d61edd3da3cf2c8e1a8c.svg

Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)