diff --git a/docs/reference/api/abort-a-batch-update.api.mdx b/docs/reference/api/abort-a-batch-update.api.mdx index 8cf0f75b..6a39e77a 100644 --- a/docs/reference/api/abort-a-batch-update.api.mdx +++ b/docs/reference/api/abort-a-batch-update.api.mdx @@ -1,11 +1,11 @@ --- id: abort-a-batch-update title: "Abort a batch update" -description: "**Experimental**: This API is not stable and might be subject of change.
" +description: "Abort a batch update." sidebar_label: "Abort a batch update" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nAbort a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch aborted."}}}}},"method":"delete","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Abort a batch update","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nAbort a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +api: {"description":"Abort a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch aborted."}}}}},"method":"delete","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Abort a batch update","description":{"content":"Abort a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} sidebar_class_name: "delete api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Abort a batch update. +Abort a batch update. " +description: "Commit a batch update." sidebar_label: "Commit a batch update" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nCommit a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch committed."}}}}},"method":"post","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Commit a batch update","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nCommit a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +api: {"description":"Commit a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch committed."}}}}},"method":"post","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Commit a batch update","description":{"content":"Commit a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} sidebar_class_name: "post api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Commit a batch update. +Commit a batch update. " +description: "Create a new node under the given parent node." sidebar_label: "Create a new node under the given parent node" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nCreate a new node under the given parent node.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}},{"name":"parent_node_id","in":"path","description":"The identifier of the parent node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The node document to create.","content":{"application/json":{"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"}}}},"responses":{"200":{"description":"Return the created node","content":{"application/json":{"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"}}}}},"method":"post","path":"/graph/{graph_id}/node/{node_id}/under/{parent_node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Create a new node under the given parent node","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nCreate a new node under the given parent node.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id","under",":parent_node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the parent node","type":"text/plain"},"type":"any","value":"","key":"parent_node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Create a new node under the given parent node.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}},{"name":"parent_node_id","in":"path","description":"The identifier of the parent node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The node document to create.","content":{"application/json":{"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"}}}},"responses":{"200":{"description":"Return the created node","content":{"application/json":{"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"}}}}},"method":"post","path":"/graph/{graph_id}/node/{node_id}/under/{parent_node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Create a new node under the given parent node","description":{"content":"Create a new node under the given parent node.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id","under",":parent_node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the parent node","type":"text/plain"},"type":"any","value":"","key":"parent_node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Create a new node under the given parent node. +Create a new node under the given parent node. " +description: "Delete a configuration identified by id with provided value." sidebar_label: "Delete a configuration by its id" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nDelete a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","in":"path","required":true,"description":"the identifier of the config to get.","schema":{"type":"string"}}],"responses":{"204":{"description":"Signals success of this operation."}},"method":"delete","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a configuration by its id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nDelete a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"method":"DELETE"}} +api: {"description":"Delete a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","in":"path","required":true,"description":"the identifier of the config to get.","schema":{"type":"string"}}],"responses":{"204":{"description":"Signals success of this operation."}},"method":"delete","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a configuration by its id","description":{"content":"Delete a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"method":"DELETE"}} sidebar_class_name: "delete api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Delete a configuration identified by id with provided value. +Delete a configuration identified by id with provided value. " +description: "Delete a node with the given node id." sidebar_label: "Delete a node with the given node id." hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nDelete a node with the given node id.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Node is deleted"}},"method":"delete","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a node with the given node id.","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nDelete a node with the given node id.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"method":"DELETE"}} +api: {"description":"Delete a node with the given node id.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Node is deleted"}},"method":"delete","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a node with the given node id.","description":{"content":"Delete a node with the given node id.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"method":"DELETE"}} sidebar_class_name: "delete api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Delete a node with the given node id. +Delete a node with the given node id. " +description: "Fetch a configuration by id." sidebar_label: "Get a configuration by its id" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nFetch a configuration by id.\n","tags":["config"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the config to get.","schema":{"type":"string"}}],"responses":{"200":{"description":"The configuration","headers":{"Fix-Config-Revision":{"description":"The revision of this config","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"404":{"description":"No configuration for this key."}},"method":"get","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a configuration by its id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nFetch a configuration by id.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"description":"Fetch a configuration by id.\n","tags":["config"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the config to get.","schema":{"type":"string"}}],"responses":{"200":{"description":"The configuration","headers":{"Fix-Config-Revision":{"description":"The revision of this config","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"404":{"description":"No configuration for this key."}},"method":"get","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a configuration by its id","description":{"content":"Fetch a configuration by id.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Fetch a configuration by id. +Fetch a configuration by id. " +description: "Fetch the validation of a configuration by id." sidebar_label: "Get a configuration validation by its id" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nFetch the validation of a configuration by id.\n","tags":["config_validation"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the configuration validation.","schema":{"type":"string"}}],"responses":{"200":{"description":"The configuration validation.","content":{"application/json":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}},"application/yaml":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}}}},"404":{"description":"No config validation for this key."}},"method":"get","path":"/config/{config_id}/validation","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a configuration validation by its id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nFetch the validation of a configuration by id.\n","type":"text/plain"},"url":{"path":["config",":config_id","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the configuration validation.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"description":"Fetch the validation of a configuration by id.\n","tags":["config_validation"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the configuration validation.","schema":{"type":"string"}}],"responses":{"200":{"description":"The configuration validation.","content":{"application/json":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}},"application/yaml":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}}}},"404":{"description":"No config validation for this key."}},"method":"get","path":"/config/{config_id}/validation","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a configuration validation by its id","description":{"content":"Fetch the validation of a configuration by id.\n","type":"text/plain"},"url":{"path":["config",":config_id","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the configuration validation.","type":"text/plain"},"type":"any","value":"","key":"config_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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Fetch the validation of a configuration by id. +Fetch the validation of a configuration by id. " +description: "Get a list of all running batch updates." sidebar_label: "Get a list of all running batch updates" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet a list of all running batch updates.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the id of the change."},"created":{"type":"string","description":"datetime in utc, when the batch update has been created"},"affected_nodes":{"type":"array","items":{"type":"string"},"description":"The root nodes of the subgraphs that will be changed during the update"}},"example":[{"id":"XYQaijCNJUVc","created":"2021-06-29T13:53:39.329Z","affected_nodes":["sub_graph_root_1","sub_graph_root_2"]}],"title":"BatchUpdate"}}}}},"method":"get","path":"/graph/{graph_id}/batch","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a list of all running batch updates","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet a list of all running batch updates.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch"],"host":["{{baseUrl}}"],"query":[],"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: {"description":"Get a list of all running batch updates.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the id of the change."},"created":{"type":"string","description":"datetime in utc, when the batch update has been created"},"affected_nodes":{"type":"array","items":{"type":"string"},"description":"The root nodes of the subgraphs that will be changed during the update"}},"example":[{"id":"XYQaijCNJUVc","created":"2021-06-29T13:53:39.329Z","affected_nodes":["sub_graph_root_1","sub_graph_root_2"]}],"title":"BatchUpdate"}}}}},"method":"get","path":"/graph/{graph_id}/batch","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a list of all running batch updates","description":{"content":"Get a list of all running batch updates.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch"],"host":["{{baseUrl}}"],"query":[],"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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Get a list of all running batch updates. +Get a list of all running batch updates. " +description: "Get a node with the given node id" sidebar_label: "Get a node with the given node id" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet a node with the given node id\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Return the defined node","content":{"application/json":{"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"}}}}},"method":"get","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a node with the given node id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet a node with the given node id\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"description":"Get a node with the given node id\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Return the defined node","content":{"application/json":{"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"}}}}},"method":"get","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a node with the given node id","description":{"content":"Get a node with the given node id\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Get a node with the given node id +Get a node with the given node id " +description: "Get all configuration keys that have a model defined." sidebar_label: "Get all configuration keys that have a model defined." hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet all configuration keys that have a model defined.\n","tags":["config_validation"],"responses":{"200":{"description":"All configuration keys that have a model.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"method":"get","path":"/configs/validation","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get all configuration keys that have a model defined.","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet all configuration keys that have a model defined.\n","type":"text/plain"},"url":{"path":["configs","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"description":"Get all configuration keys that have a model defined.\n","tags":["config_validation"],"responses":{"200":{"description":"All configuration keys that have a model.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"method":"get","path":"/configs/validation","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get all configuration keys that have a model defined.","description":{"content":"Get all configuration keys that have a model defined.\n","type":"text/plain"},"url":{"path":["configs","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Get all configuration keys that have a model defined. +Get all configuration keys that have a model defined.
diff --git a/docs/reference/api/get-all-configuration-keys.api.mdx b/docs/reference/api/get-all-configuration-keys.api.mdx index 3b54c004..374d7db2 100644 --- a/docs/reference/api/get-all-configuration-keys.api.mdx +++ b/docs/reference/api/get-all-configuration-keys.api.mdx @@ -1,11 +1,11 @@ --- id: get-all-configuration-keys title: "Get all configuration keys" -description: "**Experimental**: This API is not stable and might be subject of change.
" +description: "Get all configuration keys in the system." sidebar_label: "Get all configuration keys" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet all configuration keys in the system.\n","tags":["config"],"responses":{"200":{"description":"All configuration keys.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"method":"get","path":"/configs","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get all configuration keys","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet all configuration keys in the system.\n","type":"text/plain"},"url":{"path":["configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"description":"Get all configuration keys in the system.\n","tags":["config"],"responses":{"200":{"description":"All configuration keys.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"method":"get","path":"/configs","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get all configuration keys","description":{"content":"Get all configuration keys in the system.\n","type":"text/plain"},"url":{"path":["configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Get all configuration keys in the system. +Get all configuration keys in the system.
diff --git a/docs/reference/api/get-information-about-cli.api.mdx b/docs/reference/api/get-information-about-cli.api.mdx index f3731d12..5cfbc41a 100644 --- a/docs/reference/api/get-information-about-cli.api.mdx +++ b/docs/reference/api/get-information-about-cli.api.mdx @@ -1,11 +1,11 @@ --- id: get-information-about-cli title: "Get information about CLI" -description: "**Experimental**: This API is not stable and might be subject of change.
" +description: "Get information about CLI" sidebar_label: "Get information about CLI" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet information about CLI\n","tags":["cli"],"responses":{"200":{"description":"name, information and help of available commands.","content":{"application/json":{"schema":{"type":"object","description":"Information about the CLI","properties":{"commands":{"description":"All available commands","type":"array","items":{"type":"object","description":"Information about a CLI command","properties":{"name":{"type":"string","description":"The name of the CLI command."},"args":{"oneOf":[{"type":"array"},{"type":"object","title":"CLICommandArg"}]},"info":{"type":"string","description":"Short description."},"help":{"type":"string","description":"Help text of the CLI command."},"source":{"type":"boolean","description":"Indicates, if the command is allowed in source position (first command in a chain)."}},"title":"CLICommand"}},"replacements":{"description":"All available replacements with current value","type":"object","additionalProperties":{"type":"string"}},"alias_names":{"description":"All available aliases","type":"object","additionalProperties":{"type":"string"}},"alias_templates":{"description":"All available alias template name.","type":"array","items":{"type":"object","description":"Information about a CLI command","properties":{"name":{"type":"string","description":"The name of the CLI command."},"args":{"oneOf":[{"type":"array"},{"type":"object","title":"CLICommandArg"}]},"info":{"type":"string","description":"Short description."},"help":{"type":"string","description":"Help text of the CLI command."},"source":{"type":"boolean","description":"Indicates, if the command is allowed in source position (first command in a chain)."}},"title":"CLICommand"}}},"title":"CLIInfo"}}}}},"method":"get","path":"/cli/info","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get information about CLI","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet information about CLI\n","type":"text/plain"},"url":{"path":["cli","info"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"description":"Get information about CLI\n","tags":["cli"],"responses":{"200":{"description":"name, information and help of available commands.","content":{"application/json":{"schema":{"type":"object","description":"Information about the CLI","properties":{"commands":{"description":"All available commands","type":"array","items":{"type":"object","description":"Information about a CLI command","properties":{"name":{"type":"string","description":"The name of the CLI command."},"args":{"oneOf":[{"type":"array"},{"type":"object","title":"CLICommandArg"}]},"info":{"type":"string","description":"Short description."},"help":{"type":"string","description":"Help text of the CLI command."},"source":{"type":"boolean","description":"Indicates, if the command is allowed in source position (first command in a chain)."}},"title":"CLICommand"}},"replacements":{"description":"All available replacements with current value","type":"object","additionalProperties":{"type":"string"}},"alias_names":{"description":"All available aliases","type":"object","additionalProperties":{"type":"string"}},"alias_templates":{"description":"All available alias template name.","type":"array","items":{"type":"object","description":"Information about a CLI command","properties":{"name":{"type":"string","description":"The name of the CLI command."},"args":{"oneOf":[{"type":"array"},{"type":"object","title":"CLICommandArg"}]},"info":{"type":"string","description":"Short description."},"help":{"type":"string","description":"Help text of the CLI command."},"source":{"type":"boolean","description":"Indicates, if the command is allowed in source position (first command in a chain)."}},"title":"CLICommand"}}},"title":"CLIInfo"}}}}},"method":"get","path":"/cli/info","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get information about CLI","description":{"content":"Get information about CLI\n","type":"text/plain"},"url":{"path":["cli","info"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Get information about CLI +Get information about CLI
diff --git a/docs/reference/api/load-time-series-data.api.mdx b/docs/reference/api/load-time-series-data.api.mdx index 4cb5fa47..bfc13769 100644 --- a/docs/reference/api/load-time-series-data.api.mdx +++ b/docs/reference/api/load-time-series-data.api.mdx @@ -5,7 +5,7 @@ description: "Load time series data." sidebar_label: "Load time series data." hide_title: true hide_table_of_contents: true -api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-05T17:24:43.057Z","end":"2024-12-05T17:24:43.057Z","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-11T08:53:11.596Z","end":"2024-12-11T08:53:11.596Z","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/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update.api.mdx b/docs/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update.api.mdx index c1c4048b..c6d78f66 100644 --- a/docs/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update.api.mdx +++ b/docs/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update.api.mdx @@ -1,11 +1,11 @@ --- id: merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update title: "Merge a given graph with the existing graph under marked merge nodes as batch update." -description: "**Experimental**: This API is not stable and might be subject of change.
" +description: "Merge a given graph with the existing graph under marked merge nodes as batch update." sidebar_label: "Merge a given graph with the existing graph under marked merge nodes as batch update." hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nMerge a given graph with the existing graph under marked merge nodes as batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"query","description":"A batch identifier is a string that uniquely identifies the batch update. If this parameter is omitted, a new batch identifier is created automatically. The resulting batch identifier can be retrieved via the response message.\n","required":false,"schema":{"default":null,"type":"string"}},{"name":"wait_for_result","in":"query","description":"If this parameter is set, the request will block until the batch update is finished. The response will contain the batch identifier and the result of the batch update.\n","schema":{"default":true,"type":"boolean"}}],"requestBody":{"description":"The graph is sent as newline delimited json, where each line holds a document, which is either a node or an edge.","required":true,"content":{"application/x-ndjson":{"schema":{"oneOf":[{"type":"object","example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},{"type":"object","example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}]},"example":[{"id":"a","data":{"kind":"loadbalancer","ip":"1.2.3.4","mathod":"roundrobin"}},{"id":"b","data":{"kind":"compute_instance","machine_type":"gt-5","cores":24}},{"from":"a","to":"b","edge_type":"default"},{"id":"c","data":{"kind":"compute_instance","machine_type":"gt-5","cores":24}},{"from":"a","to":"c","edge_type":"default"}]}}},"responses":{"200":{"description":"Return a summary of actions that has been applied.","content":{"application/json":{"schema":{"description":"Summary of a graph change action","type":"object","properties":{"nodes_created":{"description":"The number of nodes that have been created.","type":"integer"},"nodes_updates":{"description":"The number of nodes that have been updated.","type":"integer"},"nodes_deleted":{"description":"The number of nodes that have been deleted.","type":"integer"},"edges_created":{"description":"The number of edges that have been created.","type":"integer"},"edges_updated":{"description":"The number of edges that have been updated.","type":"integer"},"edges_deleted":{"description":"The number of edges that have been deleted.","type":"integer"}},"title":"GraphUpdate"}}}}},"method":"post","path":"/graph/{graph_id}/batch/merge","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Merge a given graph with the existing graph under marked merge nodes as batch update.","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nMerge a given graph with the existing graph under marked merge nodes as batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch","merge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A batch identifier is a string that uniquely identifies the batch update. If this parameter is omitted, a new batch identifier is created automatically. The resulting batch identifier can be retrieved via the response message.\n","type":"text/plain"},"key":"batch_id","value":""},{"disabled":false,"description":{"content":"If this parameter is set, the request will block until the batch update is finished. The response will contain the batch identifier and the result of the batch update.\n","type":"text/plain"},"key":"wait_for_result","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":"application/x-ndjson"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Merge a given graph with the existing graph under marked merge nodes as batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"query","description":"A batch identifier is a string that uniquely identifies the batch update. If this parameter is omitted, a new batch identifier is created automatically. The resulting batch identifier can be retrieved via the response message.\n","required":false,"schema":{"default":null,"type":"string"}},{"name":"wait_for_result","in":"query","description":"If this parameter is set, the request will block until the batch update is finished. The response will contain the batch identifier and the result of the batch update.\n","schema":{"default":true,"type":"boolean"}}],"requestBody":{"description":"The graph is sent as newline delimited json, where each line holds a document, which is either a node or an edge.","required":true,"content":{"application/x-ndjson":{"schema":{"oneOf":[{"type":"object","example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},{"type":"object","example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}]},"example":[{"id":"a","data":{"kind":"loadbalancer","ip":"1.2.3.4","mathod":"roundrobin"}},{"id":"b","data":{"kind":"compute_instance","machine_type":"gt-5","cores":24}},{"from":"a","to":"b","edge_type":"default"},{"id":"c","data":{"kind":"compute_instance","machine_type":"gt-5","cores":24}},{"from":"a","to":"c","edge_type":"default"}]}}},"responses":{"200":{"description":"Return a summary of actions that has been applied.","content":{"application/json":{"schema":{"description":"Summary of a graph change action","type":"object","properties":{"nodes_created":{"description":"The number of nodes that have been created.","type":"integer"},"nodes_updates":{"description":"The number of nodes that have been updated.","type":"integer"},"nodes_deleted":{"description":"The number of nodes that have been deleted.","type":"integer"},"edges_created":{"description":"The number of edges that have been created.","type":"integer"},"edges_updated":{"description":"The number of edges that have been updated.","type":"integer"},"edges_deleted":{"description":"The number of edges that have been deleted.","type":"integer"}},"title":"GraphUpdate"}}}}},"method":"post","path":"/graph/{graph_id}/batch/merge","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Merge a given graph with the existing graph under marked merge nodes as batch update.","description":{"content":"Merge a given graph with the existing graph under marked merge nodes as batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch","merge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A batch identifier is a string that uniquely identifies the batch update. If this parameter is omitted, a new batch identifier is created automatically. The resulting batch identifier can be retrieved via the response message.\n","type":"text/plain"},"key":"batch_id","value":""},{"disabled":false,"description":{"content":"If this parameter is set, the request will block until the batch update is finished. The response will contain the batch identifier and the result of the batch update.\n","type":"text/plain"},"key":"wait_for_result","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":"application/x-ndjson"},{"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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Merge a given graph with the existing graph under marked merge nodes as batch update. +Merge a given graph with the existing graph under marked merge nodes as batch update. " +description: "Patch a configuration identified by id with provided value." sidebar_label: "Patch a configuration by its id" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nPatch a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the config to get.","schema":{"type":"string"}},{"name":"validate","required":false,"in":"query","description":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","schema":{"type":"boolean"}},{"name":"dry_run","required":false,"in":"query","description":"This parameter can be used to test if the config could be patched without really changing it.\nIt will perform all validations but not store the new value.\n","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"The configuration","headers":{"Fix-Config-Revision":{"description":"The revision of this config","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"method":"patch","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Patch a configuration by its id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nPatch a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","type":"text/plain"},"key":"validate","value":""},{"disabled":false,"description":{"content":"This parameter can be used to test if the config could be patched without really changing it.\nIt will perform all validations but not store the new value.\n","type":"text/plain"},"key":"dry_run","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Patch a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the config to get.","schema":{"type":"string"}},{"name":"validate","required":false,"in":"query","description":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","schema":{"type":"boolean"}},{"name":"dry_run","required":false,"in":"query","description":"This parameter can be used to test if the config could be patched without really changing it.\nIt will perform all validations but not store the new value.\n","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"The configuration","headers":{"Fix-Config-Revision":{"description":"The revision of this config","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"method":"patch","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Patch a configuration by its id","description":{"content":"Patch a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","type":"text/plain"},"key":"validate","value":""},{"disabled":false,"description":{"content":"This parameter can be used to test if the config could be patched without really changing it.\nIt will perform all validations but not store the new value.\n","type":"text/plain"},"key":"dry_run","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Patch a configuration identified by id with provided value. +Patch a configuration identified by id with provided value. " +description: "Patch a node with the given node id in given section" sidebar_label: "Patch a node with the given node id in given section" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nPatch a node with the given node id in given section\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"path","required":true,"description":"The name of the section used for all property paths. If not defined root is assumed.","schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The partial object data to patch.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Return the patched node","content":{"application/json":{"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"}}}}},"method":"patch","path":"/graph/{graph_id}/node/{node_id}/section/{section}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Patch a node with the given node id in given section","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nPatch a node with the given node id in given section\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id","section",":section"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"type":"any","value":"","key":"section"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Patch a node with the given node id in given section\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"path","required":true,"description":"The name of the section used for all property paths. If not defined root is assumed.","schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The partial object data to patch.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Return the patched node","content":{"application/json":{"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"}}}}},"method":"patch","path":"/graph/{graph_id}/node/{node_id}/section/{section}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Patch a node with the given node id in given section","description":{"content":"Patch a node with the given node id in given section\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id","section",":section"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"type":"any","value":"","key":"section"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Patch a node with the given node id in given section +Patch a node with the given node id in given section " +description: "Replace a configuration validation identified by id with provided value." sidebar_label: "Replace a configuration validation with given id" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nReplace a configuration validation identified by id with provided value.\n","tags":["config_validation"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the configuration validation to replace.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}}}},"responses":{"200":{"description":"The configuration validation.","content":{"application/json":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}}}}},"method":"put","path":"/config/{config_id}/validation","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"string","external_validation":true},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Replace a configuration validation with given id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nReplace a configuration validation identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the configuration validation to replace.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Replace a configuration validation identified by id with provided value.\n","tags":["config_validation"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the configuration validation to replace.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}}}},"responses":{"200":{"description":"The configuration validation.","content":{"application/json":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}}}}},"method":"put","path":"/config/{config_id}/validation","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"string","external_validation":true},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Replace a configuration validation with given id","description":{"content":"Replace a configuration validation identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the configuration validation to replace.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Replace a configuration validation identified by id with provided value. +Replace a configuration validation identified by id with provided value. " +description: "Replace a configuration identified by id with provided value." sidebar_label: "Replace a configuration with given id" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nReplace a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the config to get.","schema":{"type":"string"}},{"name":"validate","required":false,"in":"query","description":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","schema":{"type":"boolean"}},{"name":"dry_run","required":false,"in":"query","description":"This parameter can be used to test if the config could be updated without really changing it.\nIt will perform all validations but not store the new value.\n","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"The configuration","headers":{"Fix-Config-Revision":{"description":"The revision of this config","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"method":"put","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Replace a configuration with given id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nReplace a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","type":"text/plain"},"key":"validate","value":""},{"disabled":false,"description":{"content":"This parameter can be used to test if the config could be updated without really changing it.\nIt will perform all validations but not store the new value.\n","type":"text/plain"},"key":"dry_run","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Replace a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the config to get.","schema":{"type":"string"}},{"name":"validate","required":false,"in":"query","description":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","schema":{"type":"boolean"}},{"name":"dry_run","required":false,"in":"query","description":"This parameter can be used to test if the config could be updated without really changing it.\nIt will perform all validations but not store the new value.\n","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"The configuration","headers":{"Fix-Config-Revision":{"description":"The revision of this config","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"method":"put","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Replace a configuration with given id","description":{"content":"Replace a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","type":"text/plain"},"key":"validate","value":""},{"disabled":false,"description":{"content":"This parameter can be used to test if the config could be updated without really changing it.\nIt will perform all validations but not store the new value.\n","type":"text/plain"},"key":"dry_run","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Replace a configuration identified by id with provided value. +Replace a configuration identified by id with provided value. " +description: "Show the underlying raw search." sidebar_label: "Transform the search into the raw database search" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nShow the underlying raw search.\n","tags":["debug"],"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":"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":"Returns the search as performed by the database.","content":{"application/json":{"schema":{"type":"object","description":"The raw query as performed by the database","properties":{"query":{"type":"string","description":"The string representation of the query"},"bind_vars":{"type":"object","description":"All binding variables for this query","additionalProperties":true}},"title":"RawQuery"}}}}},"method":"post","path":"/graph/{graph_id}/search/raw","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Transform the search into the raw database search","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nShow the underlying raw search.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","raw"],"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":"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":"Show the underlying raw search.\n","tags":["debug"],"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":"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":"Returns the search as performed by the database.","content":{"application/json":{"schema":{"type":"object","description":"The raw query as performed by the database","properties":{"query":{"type":"string","description":"The string representation of the query"},"bind_vars":{"type":"object","description":"All binding variables for this query","additionalProperties":true}},"title":"RawQuery"}}}}},"method":"post","path":"/graph/{graph_id}/search/raw","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Transform the search into the raw database search","description":{"content":"Show the underlying raw search.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","raw"],"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":"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 @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Show the underlying raw search. +Show the underlying raw search. " +description: "Update a node with the given node id" sidebar_label: "Update a node with the given node id" hide_title: true hide_table_of_contents: true -api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nUpdate a node with the given node id\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The partial object data to patch.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Return the patched node","content":{"application/json":{"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"}}}}},"method":"patch","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Update a node with the given node id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nUpdate a node with the given node id\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Update a node with the given node id\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The partial object data to patch.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Return the patched node","content":{"application/json":{"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"}}}}},"method":"patch","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Update a node with the given node id","description":{"content":"Update a node with the given node id\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem"; -**Experimental**: This API is not stable and might be subject of change.
Update a node with the given node id +Update a node with the given node id gcp_deprecation_status gcp_notification_endpoint --> gcp_notification_endpoint_grpc_settings gcp_resource <|--- gcp_notification_endpoint -phantom_resource <|--- gcp_notification_endpoint gcp_notification_endpoint_grpc_settings --> gcp_duration gcp_resource --> gcp_deprecation_status resource <|--- gcp_resource -resource <|--- phantom_resource @enduml ``` diff --git a/openapi/fixcore-edge.yml b/openapi/fixcore-edge.yml index ab3b2c23..7bebac85 100644 --- a/openapi/fixcore-edge.yml +++ b/openapi/fixcore-edge.yml @@ -425,7 +425,6 @@ paths: post: summary: 'Merge a given graph with the existing graph under marked merge nodes as batch update.' description: | - **Experimental**: This API is not stable and might be subject of change.
Merge a given graph with the existing graph under marked merge nodes as batch update. tags: - graph_management @@ -500,7 +499,6 @@ paths: get: summary: 'Get a list of all running batch updates' description: | - **Experimental**: This API is not stable and might be subject of change.
Get a list of all running batch updates. tags: - graph_management @@ -517,7 +515,6 @@ paths: post: summary: 'Commit a batch update' description: | - **Experimental**: This API is not stable and might be subject of change.
Commit a batch update. tags: - graph_management @@ -540,7 +537,6 @@ paths: delete: summary: 'Abort a batch update' description: | - **Experimental**: This API is not stable and might be subject of change.
Abort a batch update. tags: - graph_management @@ -621,7 +617,6 @@ paths: post: summary: 'Create a new node under the given parent node' description: | - **Experimental**: This API is not stable and might be subject of change.
Create a new node under the given parent node. tags: - node_management @@ -656,7 +651,6 @@ paths: get: summary: 'Get a node with the given node id' description: | - **Experimental**: This API is not stable and might be subject of change.
Get a node with the given node id tags: - node_management @@ -678,7 +672,6 @@ paths: patch: summary: 'Update a node with the given node id' description: | - **Experimental**: This API is not stable and might be subject of change.
Update a node with the given node id tags: - node_management @@ -707,7 +700,6 @@ paths: delete: summary: 'Delete a node with the given node id.' description: | - **Experimental**: This API is not stable and might be subject of change.
Delete a node with the given node id. tags: - node_management @@ -726,7 +718,6 @@ paths: patch: summary: 'Patch a node with the given node id in given section' description: | - **Experimental**: This API is not stable and might be subject of change.
Patch a node with the given node id in given section tags: - node_management @@ -760,7 +751,6 @@ paths: post: summary: 'Transform the search into the raw database search' description: | - **Experimental**: This API is not stable and might be subject of change.
Show the underlying raw search. tags: - debug @@ -2163,7 +2153,6 @@ paths: get: summary: 'Get all configuration keys' description: | - **Experimental**: This API is not stable and might be subject of change.
Get all configuration keys in the system. tags: - config @@ -2222,7 +2211,6 @@ paths: get: summary: 'Get all configuration keys that have a model defined.' description: | - **Experimental**: This API is not stable and might be subject of change.
Get all configuration keys that have a model defined. tags: - config_validation @@ -2239,7 +2227,6 @@ paths: get: summary: 'Get a configuration by its id' description: | - **Experimental**: This API is not stable and might be subject of change.
Fetch a configuration by id. tags: - config @@ -2268,7 +2255,6 @@ paths: put: summary: 'Replace a configuration with given id' description: | - **Experimental**: This API is not stable and might be subject of change.
Replace a configuration identified by id with provided value. tags: - config @@ -2317,7 +2303,6 @@ paths: patch: summary: 'Patch a configuration by its id' description: | - **Experimental**: This API is not stable and might be subject of change.
Patch a configuration identified by id with provided value. tags: - config @@ -2366,7 +2351,6 @@ paths: delete: summary: 'Delete a configuration by its id' description: | - **Experimental**: This API is not stable and might be subject of change.
Delete a configuration identified by id with provided value. tags: - config @@ -2384,7 +2368,6 @@ paths: get: summary: 'Get a configuration validation by its id' description: | - **Experimental**: This API is not stable and might be subject of change.
Fetch the validation of a configuration by id. tags: - config_validation @@ -2410,7 +2393,6 @@ paths: put: summary: 'Replace a configuration validation with given id' description: | - **Experimental**: This API is not stable and might be subject of change.
Replace a configuration validation identified by id with provided value. tags: - config_validation @@ -2523,7 +2505,6 @@ paths: get: summary: Get information about CLI description: | - **Experimental**: This API is not stable and might be subject of change.
Get information about CLI tags: - cli 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 3f45cc40..e14cf884 100644 --- a/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx +++ b/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx @@ -5,7 +5,7 @@ description: "Load time series data." sidebar_label: "Load time series data." hide_title: true hide_table_of_contents: true -api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-05T17:24:43.426Z","end":"2024-12-05T17:24:43.426Z","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-11T08:53:11.948Z","end":"2024-12-11T08:53:11.948Z","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