Skip to content

Commit

Permalink
chore: update edge documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
some-ci committed Dec 5, 2024
1 parent a8a1e32 commit 5a83208
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/reference/api/load-time-series-data.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:22:10.033Z","end":"2024-12-05T16:22:10.033Z","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
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/unified-data-model/base/phantom_resource.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,9 @@ class gcp_interconnect_location {
}
class gcp_machine_type {
}
class gcp_notification_endpoint {
}
class gcp_region {
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/reference/unified-data-model/base/resource.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down Expand Up @@ -148,6 +153,9 @@ class gcp_resource {
**description**: string
**label_fingerprint**: string
**link**: string
}
class phantom_resource {
}
class resource {
**age**: duration
Expand All @@ -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
```
Expand Down
1 change: 1 addition & 0 deletions static/img/kroki/3e5c2e5f1a13d61edd3da3cf2c8e1a8c.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions static/img/kroki/6de2043f00b6b3f68fc9d753b56b6c85.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5a83208

Please sign in to comment.