Skip to content

Commit

Permalink
chore: update edge documentation (#215)
Browse files Browse the repository at this point in the history
  • Loading branch information
@some-ci
some-ci authored Sep 18, 2024
1 parent 2a59215 commit 6415f25
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/reference/api/load-time-series-data.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Load time series data."
sidebar_label: "Load time series data."
hide_title: true
hide_table_of_contents: true
api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-08-02T11:57:08.095Z","end":"2024-08-02T11:57:08.095Z","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-09-18T15:32:44.669Z","end":"2024-09-18T15:32:44.669Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "post api-method"
info_path: reference/api/fix-inventory-core-rest-api
custom_edit_url: null
Expand Down
36 changes: 36 additions & 0 deletions iam/aws/edge/FixCollect.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,28 @@
"backup:ListRestoreJobs",
"backup:ListRestoreTestingPlans",
"backup:ListTags",
"bedrock-agent:GetAgent",
"bedrock-agent:GetAgentVersion",
"bedrock-agent:GetFlow",
"bedrock-agent:GetFlowVersion",
"bedrock-agent:GetKnowledgeBase",
"bedrock-agent:GetPrompt",
"bedrock-agent:ListAgents",
"bedrock-agent:ListFlows",
"bedrock-agent:ListKnowledgeBases",
"bedrock-agent:ListPrompts",
"bedrock-agent:ListTagsForResource",
"bedrock:GetCustomModel",
"bedrock:GetEvaluationJob",
"bedrock:GetGuardrail",
"bedrock:GetModelCustomizationJob",
"bedrock:ListCustomModels",
"bedrock:ListEvaluationJobs",
"bedrock:ListFoundationModels",
"bedrock:ListGuardrails",
"bedrock:ListModelCustomizationJobs",
"bedrock:ListProvisionedModelThroughputs",
"bedrock:ListTagsForResource",
"cloudformation:DescribeStacks",
"cloudformation:ListStackInstances",
"cloudformation:ListStackResources",
Expand Down Expand Up @@ -152,6 +174,20 @@
"opensearch:ListDomainNames",
"organizations:ListAccounts",
"pricing:GetProducts",
"qapps:ListLibraryItems",
"qapps:ListQApps",
"qapps:ListTagsForResource",
"qbusiness:ListApplications",
"qbusiness:ListConversations",
"qbusiness:ListDataSourceSyncJobs",
"qbusiness:ListDataSources",
"qbusiness:ListDocuments",
"qbusiness:ListIndices",
"qbusiness:ListMessages",
"qbusiness:ListPlugins",
"qbusiness:ListRetrievers",
"qbusiness:ListTagsForResource",
"qbusiness:ListWebExperiences",
"rds:DescribeDbClusterSnapshots",
"rds:DescribeDbClusters",
"rds:DescribeDbInstances",
Expand Down
25 changes: 25 additions & 0 deletions iam/aws/edge/FixMutate.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,19 @@
"backup:DeleteRestoreTestingPlan",
"backup:TagResource",
"backup:UntagResource",
"bedrock-agent:DeleteAgent",
"bedrock-agent:DeleteAgentVersion",
"bedrock-agent:DeleteFlow",
"bedrock-agent:DeleteFlowVersion",
"bedrock-agent:DeleteKnowledgeBase",
"bedrock-agent:DeletePrompt",
"bedrock-agent:TagResource",
"bedrock-agent:UntagResource",
"bedrock:DeleteCustomModel",
"bedrock:DeleteGuardrail",
"bedrock:DeleteProvisionedModelThroughput",
"bedrock:TagResource",
"bedrock:UntagResource",
"cloudformation:DeleteStack",
"cloudformation:DeleteStackSet",
"cloudformation:UpdateStack",
Expand Down Expand Up @@ -155,6 +168,18 @@
"logs:DeleteLogGroup",
"logs:TagResource",
"logs:UntagResource",
"qapps:DeleteLibraryItem",
"qapps:DeleteQApp",
"qapps:TagResource",
"qapps:UntagResource",
"qbusiness:DeleteApplication",
"qbusiness:DeleteDataSource",
"qbusiness:DeleteIndex",
"qbusiness:DeletePlugin",
"qbusiness:DeleteRetriever",
"qbusiness:DeleteWebExperience",
"qbusiness:TagResource",
"qbusiness:UntagResource",
"rds:AddTagsToResource",
"rds:DeleteDbCluster",
"rds:DeleteDbInstance",
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Load time series data."
sidebar_label: "Load time series data."
hide_title: true
hide_table_of_contents: true
api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-08-02T11:57:08.455Z","end":"2024-08-02T11:57:08.455Z","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-09-18T15:32:45.027Z","end":"2024-09-18T15:32:45.027Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "post api-method"
info_path: version-4.X/reference/api/fix-inventory-core-rest-api
custom_edit_url: null
Expand Down

0 comments on commit 6415f25

Please sign in to comment.