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
some-ci committed Oct 11, 2024
1 parent 5929c29 commit fcbd08a
Show file tree
Hide file tree
Showing 10 changed files with 128 additions and 32 deletions.
26 changes: 23 additions & 3 deletions docs/reference/api/get-the-currently-defined-model.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Get the currently defined model."
sidebar_label: "Get the currently defined model."
hide_title: true
hide_table_of_contents: true
api: {"tags":["model"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}},{"name":"kind","description":"Only return information about the defined kinds. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"filter","description":"Only return information about kinds that include given string. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"with_bases","description":"Render all base classes. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}},{"name":"format","description":"The format of the returned json","in":"query","schema":{"type":"string","enum":["schema","simple"]},"required":false},{"name":"with_property_kinds","description":"Render types of property values. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The list of all kinds.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}}},"description":"Get the currently defined model.","method":"get","path":"/graph/{graph_id}/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the currently defined model.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","model"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","type":"text/plain"},"key":"flat","value":""},{"disabled":false,"description":{"content":"Only return information about the defined kinds. Comma separated list.","type":"text/plain"},"key":"kind","value":""},{"disabled":false,"description":{"content":"Only return information about kinds that include given string. Comma separated list.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Render all base classes. Only together with kind or filter","type":"text/plain"},"key":"with_bases","value":""},{"disabled":false,"description":{"content":"The format of the returned json","type":"text/plain"},"key":"format","value":""},{"disabled":false,"description":{"content":"Render types of property values. Only together with kind or filter","type":"text/plain"},"key":"with_property_kinds","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
api: {"tags":["model"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}},{"name":"format","description":"The format of the returned json","in":"query","schema":{"type":"string","enum":["schema","simple"]},"required":false},{"name":"kind","description":"Only return information about the defined kinds. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"filter","description":"Only return information about kinds that include given string. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"aggregate_roots_only","description":"Only return aggregate roots.","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_bases","description":"Include base classes and render the base section","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_property_kinds","description":"Render types of property values. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_properties","description":"Render the properties of complex kinds","in":"query","schema":{"type":"boolean","default":true}},{"name":"with_relatives","description":"Include information about relationships to other kinds.","in":"query","schema":{"type":"boolean","default":true}},{"name":"with_metadata","description":"Include metadata information.","in":"query","schema":{"oneOf":[{"type":"boolean","description":"If true, all metadata is included."},{"type":"array","description":"List of metadata keys to include.","items":{"type":"string"}}],"default":true}}],"responses":{"200":{"description":"The list of all kinds.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}}},"description":"Get the currently defined model.","method":"get","path":"/graph/{graph_id}/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the currently defined model.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","model"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","type":"text/plain"},"key":"flat","value":""},{"disabled":false,"description":{"content":"The format of the returned json","type":"text/plain"},"key":"format","value":""},{"disabled":false,"description":{"content":"Only return information about the defined kinds. Comma separated list.","type":"text/plain"},"key":"kind","value":""},{"disabled":false,"description":{"content":"Only return information about kinds that include given string. Comma separated list.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Only return aggregate roots.","type":"text/plain"},"key":"aggregate_roots_only","value":""},{"disabled":false,"description":{"content":"Include base classes and render the base section","type":"text/plain"},"key":"with_bases","value":""},{"disabled":false,"description":{"content":"Render types of property values. Only together with kind or filter","type":"text/plain"},"key":"with_property_kinds","value":""},{"disabled":false,"description":{"content":"Render the properties of complex kinds","type":"text/plain"},"key":"with_properties","value":""},{"disabled":false,"description":{"content":"Include information about relationships to other kinds.","type":"text/plain"},"key":"with_relatives","value":""},{"disabled":false,"description":{"content":"Include metadata information.","type":"text/plain"},"key":"with_metadata","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: reference/api/fix-inventory-core-rest-api
custom_edit_url: null
Expand Down Expand Up @@ -95,6 +95,11 @@ Get the currently defined model.
param={{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}}}
>

</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"format","description":"The format of the returned json","in":"query","schema":{"type":"string","enum":["schema","simple"]},"required":false}}
>

</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"kind","description":"Only return information about the defined kinds. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}}}
Expand All @@ -107,19 +112,34 @@ Get the currently defined model.

</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"with_bases","description":"Render all base classes. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}}}
param={{"name":"aggregate_roots_only","description":"Only return aggregate roots.","in":"query","schema":{"type":"boolean","default":false}}}
>

</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"format","description":"The format of the returned json","in":"query","schema":{"type":"string","enum":["schema","simple"]},"required":false}}
param={{"name":"with_bases","description":"Include base classes and render the base section","in":"query","schema":{"type":"boolean","default":false}}}
>

</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"with_property_kinds","description":"Render types of property values. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}}}
>

</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"with_properties","description":"Render the properties of complex kinds","in":"query","schema":{"type":"boolean","default":true}}}
>

</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"with_relatives","description":"Include information about relationships to other kinds.","in":"query","schema":{"type":"boolean","default":true}}}
>

</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"with_metadata","description":"Include metadata information.","in":"query","schema":{"oneOf":[{"type":"boolean","description":"If true, all metadata is included."},{"type":"array","description":"List of metadata keys to include.","items":{"type":"string"}}],"default":true}}}
>

</ParamsItem>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/load-time-series-data.api.mdx
View file
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-09-18T15:32:44.669Z","end":"2024-09-18T15:32:44.669Z","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-10-11T14:51:15.566Z","end":"2024-10-11T14:51:15.566Z","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
Loading

0 comments on commit fcbd08a

Please sign in to comment.