diff --git a/docs/reference/api/get-the-currently-defined-model.api.mdx b/docs/reference/api/get-the-currently-defined-model.api.mdx index 20cf1899..f54f4518 100644 --- a/docs/reference/api/get-the-currently-defined-model.api.mdx +++ b/docs/reference/api/get-the-currently-defined-model.api.mdx @@ -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 @@ -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}}} > + + + + + + + + diff --git a/docs/reference/api/load-time-series-data.api.mdx b/docs/reference/api/load-time-series-data.api.mdx index 6c898b59..e6d2fc25 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-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-14T12:18:14.234Z","end":"2024-10-14T12:18:14.234Z","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/api/search-all-history-events-and-return-them.api.mdx b/docs/reference/api/search-all-history-events-and-return-them.api.mdx index 532c3ac9..48bb636f 100644 --- a/docs/reference/api/search-all-history-events-and-return-them.api.mdx +++ b/docs/reference/api/search-all-history-events-and-return-them.api.mdx @@ -5,7 +5,7 @@ description: "Search all history events and return them." sidebar_label: "Search all history events and return them." hide_title: true hide_table_of_contents: true -api: {"description":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"before","in":"query","description":"Optional parameter to get all history events before the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Optional parameter to get all history events after the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(volume) and reported.volume_size>100"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"}}}},"method":"post","path":"/graph/{graph_id}/search/history/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search all history events and return them.","description":{"content":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"before","in":"query","description":"Optional parameter to get all history events before the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Optional parameter to get all history events after the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(volume) and reported.volume_size>100"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"}}}},"method":"post","path":"/graph/{graph_id}/search/history/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search all history events and return them.","description":{"content":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -379,7 +379,7 @@ Search all history events and return them. A section can be defined (defaults to value={"Example"} > @@ -425,7 +425,7 @@ Search all history events and return them. A section can be defined (defaults to value={"Example"} > diff --git a/docs/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx b/docs/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx index 798508e5..80d4dc17 100644 --- a/docs/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx +++ b/docs/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx @@ -5,7 +5,7 @@ description: "Search the graph and return the matching nodes as list." sidebar_label: "Search the graph and return all nodes as list (this will not contain any edges)" hide_title: true hide_table_of_contents: true -api: {"description":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return all nodes as list (this will not contain any edges)","description":{"content":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return all nodes as list (this will not contain any edges)","description":{"content":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -364,7 +364,7 @@ Search the graph and return the matching nodes as list. A section can be defined value={"Example"} > @@ -410,7 +410,7 @@ Search the graph and return the matching nodes as list. A section can be defined value={"Example"} > diff --git a/docs/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx b/docs/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx index 5446aa35..1af81ae9 100644 --- a/docs/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx +++ b/docs/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx @@ -5,7 +5,7 @@ description: "Search the graph and return the matching nodes including the trave sidebar_label: "Search the graph and return the resulting graph." hide_title: true hide_table_of_contents: true -api: {"description":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"search_timeout","in":"query","description":"Optional duration the search is allowed to run.","required":false,"schema":{"type":"string","example":"30s"}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/graph","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return the resulting graph.","description":{"content":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","graph"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional duration the search is allowed to run.","type":"text/plain"},"key":"search_timeout","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"search_timeout","in":"query","description":"Optional duration the search is allowed to run.","required":false,"schema":{"type":"string","example":"30s"}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/graph","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return the resulting graph.","description":{"content":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","graph"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional duration the search is allowed to run.","type":"text/plain"},"key":"search_timeout","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -369,7 +369,7 @@ Search the graph and return the matching nodes including the traversed edges. Th value={"Example"} > @@ -415,7 +415,7 @@ Search the graph and return the matching nodes including the traversed edges. Th value={"Example"} > diff --git a/iam/aws/edge/FixCollect.json b/iam/aws/edge/FixCollect.json index 050824be..f55ad31e 100644 --- a/iam/aws/edge/FixCollect.json +++ b/iam/aws/edge/FixCollect.json @@ -14,6 +14,7 @@ "athena:ListTagsForResource", "athena:ListWorkGroups", "autoscaling:DescribeAutoScalingGroups", + "backup:GetBackupVaultAccessPolicy", "backup:ListBackupJobs", "backup:ListBackupPlans", "backup:ListBackupVaults", @@ -73,6 +74,7 @@ "cloudtrail:ListTags", "cloudtrail:ListTrails", "cloudwatch:DescribeAlarms", + "cloudwatch:DescribeResourcePolicies", "cloudwatch:GetMetricData", "cognito-idp:ListGroups", "cognito-idp:ListTagsForResource", @@ -83,6 +85,7 @@ "dynamodb:DescribeContinuousBackups", "dynamodb:DescribeGlobalTable", "dynamodb:DescribeTable", + "dynamodb:GetResourcePolicy", "dynamodb:ListGlobalTables", "dynamodb:ListTables", "dynamodb:ListTagsOfResource", @@ -111,6 +114,7 @@ "ecr-public:DescribeRepositories", "ecr:DescribeRepositories", "ecr:GetLifecyclePolicy", + "ecr:GetRepositoryPolicy", "ecs:DescribeCapacityProviders", "ecs:DescribeClusters", "ecs:DescribeContainerInstances", @@ -157,6 +161,7 @@ "iam:ListInstanceProfiles", "iam:ListServerCertificates", "kinesis:DescribeStream", + "kinesis:GetResourcePolicy", "kinesis:ListStreams", "kinesis:ListTagsForStream", "kms:DescribeKey", @@ -200,6 +205,7 @@ "route53:ListTagsForResource", "s3:GetAccountPublicAccessBlock", "s3:GetBucketAcl", + "s3:GetBucketLifecycleConfiguration", "s3:GetBucketLocation", "s3:GetBucketLogging", "s3:GetBucketPolicy", @@ -249,6 +255,7 @@ "sagemaker:ListTrials", "sagemaker:ListUserProfiles", "sagemaker:ListWorkteams", + "secretsmanager:GetResourcePolicy", "secretsmanager:ListSecrets", "servicequotas:ListServiceQuotas", "sns:GetPlatformApplicationAttributes", diff --git a/iam/gcp/edge/fix_access.json b/iam/gcp/edge/fix_access.json index e8d4b5a4..9a48336b 100644 --- a/iam/gcp/edge/fix_access.json +++ b/iam/gcp/edge/fix_access.json @@ -3,6 +3,22 @@ "description": "Permissions required to collect resources.", "stage": "GA", "includedPermissions": [ + "aiplatform.projects.locations.batchPredictionJobs.list", + "aiplatform.projects.locations.customJobs.list", + "aiplatform.projects.locations.datasets.list", + "aiplatform.projects.locations.endpoints.list", + "aiplatform.projects.locations.featureGroups.list", + "aiplatform.projects.locations.featurestores.list", + "aiplatform.projects.locations.hyperparameterTuningJobs.list", + "aiplatform.projects.locations.indexEndpoints.list", + "aiplatform.projects.locations.indexes.list", + "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list", + "aiplatform.projects.locations.models.list", + "aiplatform.projects.locations.pipelineJobs.list", + "aiplatform.projects.locations.schedules.list", + "aiplatform.projects.locations.tensorboards.list", + "aiplatform.projects.locations.trainingPipelines.list", + "aiplatform.projects.locations.tuningJobs.list", "cloudsql.backupRuns.list", "cloudsql.databases.list", "cloudsql.instances.get", diff --git a/iam/gcp/edge/fix_mutate.json b/iam/gcp/edge/fix_mutate.json index 349367b5..0a1386eb 100644 --- a/iam/gcp/edge/fix_mutate.json +++ b/iam/gcp/edge/fix_mutate.json @@ -3,6 +3,38 @@ "description": "Permissions required to mutate resources.", "stage": "GA", "includedPermissions": [ + "aiplatform.projects.locations.batchPredictionJobs.delete", + "aiplatform.projects.locations.batchPredictionJobs.setLabels", + "aiplatform.projects.locations.customJobs.delete", + "aiplatform.projects.locations.customJobs.setLabels", + "aiplatform.projects.locations.datasets.delete", + "aiplatform.projects.locations.datasets.setLabels", + "aiplatform.projects.locations.endpoints.delete", + "aiplatform.projects.locations.endpoints.setLabels", + "aiplatform.projects.locations.featureGroups.delete", + "aiplatform.projects.locations.featureGroups.setLabels", + "aiplatform.projects.locations.featurestores.delete", + "aiplatform.projects.locations.featurestores.setLabels", + "aiplatform.projects.locations.hyperparameterTuningJobs.delete", + "aiplatform.projects.locations.hyperparameterTuningJobs.setLabels", + "aiplatform.projects.locations.indexEndpoints.delete", + "aiplatform.projects.locations.indexEndpoints.setLabels", + "aiplatform.projects.locations.indexes.delete", + "aiplatform.projects.locations.indexes.setLabels", + "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete", + "aiplatform.projects.locations.modelDeploymentMonitoringJobs.setLabels", + "aiplatform.projects.locations.models.delete", + "aiplatform.projects.locations.models.setLabels", + "aiplatform.projects.locations.pipelineJobs.delete", + "aiplatform.projects.locations.pipelineJobs.setLabels", + "aiplatform.projects.locations.schedules.delete", + "aiplatform.projects.locations.schedules.setLabels", + "aiplatform.projects.locations.tensorboards.delete", + "aiplatform.projects.locations.tensorboards.setLabels", + "aiplatform.projects.locations.trainingPipelines.delete", + "aiplatform.projects.locations.trainingPipelines.setLabels", + "aiplatform.projects.locations.tuningJobs.delete", + "aiplatform.projects.locations.tuningJobs.setLabels", "cloudsql.instances.delete", "cloudsql.instances.update", "compute.addresses.delete", diff --git a/openapi/fixcore-edge.yml b/openapi/fixcore-edge.yml index 3d73e502..ab3b2c23 100644 --- a/openapi/fixcore-edge.yml +++ b/openapi/fixcore-edge.yml @@ -57,6 +57,15 @@ paths: 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 @@ -71,27 +80,48 @@ paths: schema: type: string default: null - - name: with_bases - description: 'Render all base classes. Only together with kind or filter' + - name: aggregate_roots_only + description: 'Only return aggregate roots.' in: query schema: type: boolean default: false - - name: format - description: 'The format of the returned json' + - name: with_bases + description: 'Include base classes and render the base section' in: query schema: - type: string - enum: - - schema - - simple - required: false + 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.' @@ -817,7 +847,6 @@ paths: name: root metadata: cleaned: false - phantom: true protected: false application/yaml: example: | @@ -832,7 +861,6 @@ paths: metadata: python_type: fixlib.baseresources.GraphRoot cleaned: false - phantom: true protected: false kinds: - graph_root @@ -850,7 +878,6 @@ paths: metadata: python_type: fixlib.baseresources.Cloud cleaned: false - phantom: false protected: false descendant_summary: onelogin_account: 1 @@ -1017,7 +1044,6 @@ paths: name: root metadata: cleaned: false - phantom: true protected: false application/yaml: example: | @@ -1032,7 +1058,6 @@ paths: metadata: python_type: fixlib.baseresources.GraphRoot cleaned: false - phantom: true protected: false kinds: - graph_root @@ -1050,7 +1075,6 @@ paths: metadata: python_type: fixlib.baseresources.Cloud cleaned: false - phantom: false protected: false descendant_summary: onelogin_account: 1 @@ -1484,7 +1508,6 @@ paths: name: root metadata: cleaned: false - phantom: true protected: false application/yaml: example: | @@ -1499,7 +1522,6 @@ paths: metadata: python_type: fixlib.baseresources.GraphRoot cleaned: false - phantom: true protected: false kinds: - graph_root @@ -1517,7 +1539,6 @@ paths: metadata: python_type: fixlib.baseresources.Cloud cleaned: false - phantom: false protected: false descendant_summary: onelogin_account: 1 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 8a66751a..08c76f60 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-09-18T15:32:45.027Z","end":"2024-09-18T15:32:45.027Z","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-14T12:18:14.587Z","end":"2024-10-14T12:18:14.587Z","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