From 8eca034074757f213aec80aafd473e9cf0963314 Mon Sep 17 00:00:00 2001 From: "C.K." <98986935+some-ci@users.noreply.github.com> Date: Thu, 5 Dec 2024 13:54:07 -0800 Subject: [PATCH] chore: 4.2.0 release (#242) --- .../api/load-time-series-data.api.mdx | 2 +- iam/aws/4.X/FixCollect.json | 44 ++++ iam/aws/4.X/FixMutate.json | 24 ++ iam/gcp/4.X/fix_access.json | 29 ++- iam/gcp/4.X/fix_mutate.json | 50 ++++ latestRelease.json | 2 +- openapi/fixcore-4.X.yml | 118 +++++++-- releases/4.2.0/index.mdx | 186 ++++++++++++++ .../70c56643a1daf905379e928aabccce31.svg | 1 - .../d5898aef8ce5ff4ba6182cdf7ac1803f.svg | 1 - .../get-the-currently-defined-model.api.mdx | 26 +- .../api/load-time-series-data.api.mdx | 2 +- ...all-history-events-and-return-them.api.mdx | 6 +- ...ide-the-number-of-events-over-time.api.mdx | 243 ++++++++++++++++++ ...st-this-will-not-contain-any-edges.api.mdx | 6 +- ...aph-and-return-the-resulting-graph.api.mdx | 6 +- .../version-4.X/reference/api/sidebar.ts | 7 + 17 files changed, 716 insertions(+), 37 deletions(-) create mode 100644 releases/4.2.0/index.mdx delete mode 100644 static/img/kroki/70c56643a1daf905379e928aabccce31.svg delete mode 100644 static/img/kroki/d5898aef8ce5ff4ba6182cdf7ac1803f.svg create mode 100644 versioned_docs/version-4.X/reference/api/search-history-events-and-provide-the-number-of-events-over-time.api.mdx diff --git a/docs/reference/api/load-time-series-data.api.mdx b/docs/reference/api/load-time-series-data.api.mdx index e94676fa..4cb5fa47 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-05T16:52:09.277Z","end":"2024-12-05T16:52:09.277Z","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-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"}}}}} sidebar_class_name: "post api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null diff --git a/iam/aws/4.X/FixCollect.json b/iam/aws/4.X/FixCollect.json index 7d751114..209fec7a 100644 --- a/iam/aws/4.X/FixCollect.json +++ b/iam/aws/4.X/FixCollect.json @@ -14,6 +14,7 @@ "athena:ListTagsForResource", "athena:ListWorkGroups", "autoscaling:DescribeAutoScalingGroups", + "backup:GetBackupVaultAccessPolicy", "backup:ListBackupJobs", "backup:ListBackupPlans", "backup:ListBackupVaults", @@ -26,6 +27,27 @@ "backup:ListRestoreJobs", "backup:ListRestoreTestingPlans", "backup:ListTags", + "bedrock-agent:GetAgent", + "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", @@ -51,6 +73,7 @@ "cloudtrail:ListTags", "cloudtrail:ListTrails", "cloudwatch:DescribeAlarms", + "cloudwatch:DescribeResourcePolicies", "cloudwatch:GetMetricData", "cognito-idp:ListGroups", "cognito-idp:ListTagsForResource", @@ -61,6 +84,7 @@ "dynamodb:DescribeContinuousBackups", "dynamodb:DescribeGlobalTable", "dynamodb:DescribeTable", + "dynamodb:GetResourcePolicy", "dynamodb:ListGlobalTables", "dynamodb:ListTables", "dynamodb:ListTagsOfResource", @@ -89,6 +113,7 @@ "ecr-public:DescribeRepositories", "ecr:DescribeRepositories", "ecr:GetLifecyclePolicy", + "ecr:GetRepositoryPolicy", "ecs:DescribeCapacityProviders", "ecs:DescribeClusters", "ecs:DescribeContainerInstances", @@ -134,7 +159,9 @@ "iam:ListAccountAliases", "iam:ListInstanceProfiles", "iam:ListServerCertificates", + "inspector2:ListFindings", "kinesis:DescribeStream", + "kinesis:GetResourcePolicy", "kinesis:ListStreams", "kinesis:ListTagsForStream", "kms:DescribeKey", @@ -152,6 +179,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", @@ -164,6 +205,7 @@ "route53:ListTagsForResource", "s3:GetAccountPublicAccessBlock", "s3:GetBucketAcl", + "s3:GetBucketLifecycleConfiguration", "s3:GetBucketLocation", "s3:GetBucketLogging", "s3:GetBucketPolicy", @@ -213,6 +255,7 @@ "sagemaker:ListTrials", "sagemaker:ListUserProfiles", "sagemaker:ListWorkteams", + "secretsmanager:GetResourcePolicy", "secretsmanager:ListSecrets", "servicequotas:ListServiceQuotas", "sns:GetPlatformApplicationAttributes", @@ -229,6 +272,7 @@ "ssm:DescribeDocument", "ssm:DescribeInstanceInformation", "ssm:GetDocument", + "ssm:ListComplianceItems", "ssm:ListDocuments", "ssm:ListResourceComplianceSummaries", "wafv2:GetLoggingConfiguration", diff --git a/iam/aws/4.X/FixMutate.json b/iam/aws/4.X/FixMutate.json index b4096fd4..eccaa8ee 100644 --- a/iam/aws/4.X/FixMutate.json +++ b/iam/aws/4.X/FixMutate.json @@ -24,6 +24,18 @@ "backup:DeleteRestoreTestingPlan", "backup:TagResource", "backup:UntagResource", + "bedrock-agent:DeleteAgent", + "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", @@ -155,6 +167,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", diff --git a/iam/gcp/4.X/fix_access.json b/iam/gcp/4.X/fix_access.json index e8d4b5a4..b9d8170e 100644 --- a/iam/gcp/4.X/fix_access.json +++ b/iam/gcp/4.X/fix_access.json @@ -3,6 +3,23 @@ "description": "Permissions required to collect resources.", "stage": "GA", "includedPermissions": [ + "aiplatform.projects.locations.batchPredictionJobs.list", + "aiplatform.projects.locations.customJobs.list", + "aiplatform.projects.locations.datasets.list", + "aiplatform.projects.locations.endpoints.list", + "aiplatform.projects.locations.featureGroups.list", + "aiplatform.projects.locations.featurestores.list", + "aiplatform.projects.locations.hyperparameterTuningJobs.list", + "aiplatform.projects.locations.indexEndpoints.list", + "aiplatform.projects.locations.indexes.list", + "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list", + "aiplatform.projects.locations.models.list", + "aiplatform.projects.locations.pipelineJobs.list", + "aiplatform.projects.locations.schedules.list", + "aiplatform.projects.locations.tensorboards.list", + "aiplatform.projects.locations.trainingPipelines.list", + "aiplatform.projects.locations.tuningJobs.list", + "cloudfunctions.projects.locations.functions.list", "cloudsql.backupRuns.list", "cloudsql.databases.list", "cloudsql.instances.get", @@ -33,14 +50,12 @@ "compute.interconnects.list", "compute.licenses.list", "compute.machineImages.list", - "compute.machineTypes.get", "compute.machineTypes.list", "compute.networkEdgeSecurityServices.list", "compute.networkEndpointGroups.list", "compute.networks.list", "compute.nodeGroups.list", "compute.nodeTemplates.list", - "compute.nodeTypes.list", "compute.packetMirrorings.list", "compute.publicAdvertisedPrefixes.list", "compute.publicDelegatedPrefixes.list", @@ -68,6 +83,16 @@ "compute.vpnTunnels.list", "container.clusters.list", "container.operations.list", + "file.projects.locations.backups.list", + "file.projects.locations.instances.list", + "file.projects.locations.instances.snapshots.list", + "firestore.projects.databases.documents.list", + "firestore.projects.databases.list", + "firestore.projects.locations.backups.list", + "pubsub.projects.snapshots.list", + "pubsub.projects.subscriptions.list", + "pubsub.projects.topics.list", + "securitycenter.projects.sources.findings.list", "storage.buckets.list" ] } diff --git a/iam/gcp/4.X/fix_mutate.json b/iam/gcp/4.X/fix_mutate.json index 349367b5..dbc522c1 100644 --- a/iam/gcp/4.X/fix_mutate.json +++ b/iam/gcp/4.X/fix_mutate.json @@ -3,6 +3,40 @@ "description": "Permissions required to mutate resources.", "stage": "GA", "includedPermissions": [ + "aiplatform.projects.locations.batchPredictionJobs.delete", + "aiplatform.projects.locations.batchPredictionJobs.setLabels", + "aiplatform.projects.locations.customJobs.delete", + "aiplatform.projects.locations.customJobs.setLabels", + "aiplatform.projects.locations.datasets.delete", + "aiplatform.projects.locations.datasets.setLabels", + "aiplatform.projects.locations.endpoints.delete", + "aiplatform.projects.locations.endpoints.setLabels", + "aiplatform.projects.locations.featureGroups.delete", + "aiplatform.projects.locations.featureGroups.setLabels", + "aiplatform.projects.locations.featurestores.delete", + "aiplatform.projects.locations.featurestores.setLabels", + "aiplatform.projects.locations.hyperparameterTuningJobs.delete", + "aiplatform.projects.locations.hyperparameterTuningJobs.setLabels", + "aiplatform.projects.locations.indexEndpoints.delete", + "aiplatform.projects.locations.indexEndpoints.setLabels", + "aiplatform.projects.locations.indexes.delete", + "aiplatform.projects.locations.indexes.setLabels", + "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete", + "aiplatform.projects.locations.modelDeploymentMonitoringJobs.setLabels", + "aiplatform.projects.locations.models.delete", + "aiplatform.projects.locations.models.setLabels", + "aiplatform.projects.locations.pipelineJobs.delete", + "aiplatform.projects.locations.pipelineJobs.setLabels", + "aiplatform.projects.locations.schedules.delete", + "aiplatform.projects.locations.schedules.setLabels", + "aiplatform.projects.locations.tensorboards.delete", + "aiplatform.projects.locations.tensorboards.setLabels", + "aiplatform.projects.locations.trainingPipelines.delete", + "aiplatform.projects.locations.trainingPipelines.setLabels", + "aiplatform.projects.locations.tuningJobs.delete", + "aiplatform.projects.locations.tuningJobs.setLabels", + "cloudfunctions.projects.locations.functions.delete", + "cloudfunctions.projects.locations.functions.setLabels", "cloudsql.instances.delete", "cloudsql.instances.update", "compute.addresses.delete", @@ -92,6 +126,22 @@ "compute.vpnTunnels.delete", "container.clusters.delete", "container.clusters.update", + "file.projects.locations.backups.delete", + "file.projects.locations.backups.setLabels", + "file.projects.locations.instances.delete", + "file.projects.locations.instances.setLabels", + "firestore.projects.databases.delete", + "firestore.projects.databases.setLabels", + "firestore.projects.locations.backups.delete", + "firestore.projects.locations.backups.setLabels", + "pubsub.projects.snapshots.delete", + "pubsub.projects.snapshots.setLabels", + "pubsub.projects.subscriptions.delete", + "pubsub.projects.subscriptions.setLabels", + "pubsub.projects.topics.delete", + "pubsub.projects.topics.setLabels", + "securitycenter.projects.sources.findings.delete", + "securitycenter.projects.sources.findings.setLabels", "storage.buckets.delete", "storage.buckets.update" ] diff --git a/latestRelease.json b/latestRelease.json index 752a80a8..d0b748c3 100644 --- a/latestRelease.json +++ b/latestRelease.json @@ -1 +1 @@ -{ "4.X": "4.1.0" } +{ "4.X": "4.2.0" } diff --git a/openapi/fixcore-4.X.yml b/openapi/fixcore-4.X.yml index a53f2d33..ab3b2c23 100644 --- a/openapi/fixcore-4.X.yml +++ b/openapi/fixcore-4.X.yml @@ -57,6 +57,15 @@ paths: schema: type: boolean default: false + - name: format + description: 'The format of the returned json' + in: query + schema: + type: string + enum: + - schema + - simple + required: false - name: kind description: 'Only return information about the defined kinds. Comma separated list.' in: query @@ -71,27 +80,48 @@ paths: schema: type: string default: null - - name: with_bases - description: 'Render all base classes. Only together with kind or filter' + - name: aggregate_roots_only + description: 'Only return aggregate roots.' in: query schema: type: boolean default: false - - name: format - description: 'The format of the returned json' + - name: with_bases + description: 'Include base classes and render the base section' in: query schema: - type: string - enum: - - schema - - simple - required: false + type: boolean + default: false - name: with_property_kinds description: 'Render types of property values. Only together with kind or filter' in: query schema: type: boolean default: false + - name: with_properties + description: 'Render the properties of complex kinds' + in: query + schema: + type: boolean + default: true + - name: with_relatives + description: 'Include information about relationships to other kinds.' + in: query + schema: + type: boolean + default: true + - name: with_metadata + description: 'Include metadata information.' + in: query + schema: + oneOf: + - type: boolean + description: 'If true, all metadata is included.' + - type: array + description: 'List of metadata keys to include.' + items: + type: string + default: true responses: '200': description: 'The list of all kinds.' @@ -817,7 +847,6 @@ paths: name: root metadata: cleaned: false - phantom: true protected: false application/yaml: example: | @@ -832,7 +861,6 @@ paths: metadata: python_type: fixlib.baseresources.GraphRoot cleaned: false - phantom: true protected: false kinds: - graph_root @@ -850,7 +878,6 @@ paths: metadata: python_type: fixlib.baseresources.Cloud cleaned: false - phantom: false protected: false descendant_summary: onelogin_account: 1 @@ -1017,7 +1044,6 @@ paths: name: root metadata: cleaned: false - phantom: true protected: false application/yaml: example: | @@ -1032,7 +1058,6 @@ paths: metadata: python_type: fixlib.baseresources.GraphRoot cleaned: false - phantom: true protected: false kinds: - graph_root @@ -1050,7 +1075,6 @@ paths: metadata: python_type: fixlib.baseresources.Cloud cleaned: false - phantom: false protected: false descendant_summary: onelogin_account: 1 @@ -1340,6 +1364,67 @@ paths: application/json: schema: $ref: '#/components/schemas/EstimatedSearchCost' + /graph/{graph_id}/search/history/timeline: + post: + summary: 'Search history events and provide the number of events over time.' + description: | + Search all history events and a histogram over time. + A section can be defined (defaults to `/` == root) to interpret relative property paths. + Example: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2) + tags: + - graph_search + parameters: + - $ref: '#/components/parameters/graph_id' + - $ref: '#/components/parameters/section' + - name: before + in: query + description: 'Count all history events before the given timestamp' + required: true + schema: + type: string + format: date-time + - name: after + in: query + description: 'Count all history events after the given timestamp' + required: true + schema: + type: string + format: date-time + - name: granularity + in: query + description: 'Optional parameter to define the granularity of the timeline' + required: false + schema: + type: string + format: duration + - name: change + in: query + description: 'Optional parameter to get all history events with the given change type' + required: false + schema: + type: string + enum: + - node_created + - node_updated + - node_deleted + requestBody: + description: 'The search to perform' + content: + text/plain: + schema: + type: string + example: is(volume) and reported.volume_size>100 + responses: + '200': + description: 'The result of this search in the defined format' + content: + application/json: + example: | + [ + { "at": "2024-07-14T00:00:00.000Z", "group": { "change": "node_created" }, "v": 170 }, + { "at": "2024-07-15T00:00:00.000Z", "group": { "change": "node_updated" }, "v": 833 }, + { "at": "2024-07-15T00:00:00.000Z", "group": { "change": "node_created" }, "v": 1166 } + ] /graph/{graph_id}/search/history/list: post: summary: 'Search all history events and return them.' @@ -1423,7 +1508,6 @@ paths: name: root metadata: cleaned: false - phantom: true protected: false application/yaml: example: | @@ -1438,7 +1522,6 @@ paths: metadata: python_type: fixlib.baseresources.GraphRoot cleaned: false - phantom: true protected: false kinds: - graph_root @@ -1456,7 +1539,6 @@ paths: metadata: python_type: fixlib.baseresources.Cloud cleaned: false - phantom: false protected: false descendant_summary: onelogin_account: 1 diff --git a/releases/4.2.0/index.mdx b/releases/4.2.0/index.mdx new file mode 100644 index 00000000..ef9bd91e --- /dev/null +++ b/releases/4.2.0/index.mdx @@ -0,0 +1,186 @@ +--- +date: 2024-12-05 +--- + +# 4.2.0 + +## What's Changed + +### Features + +- [`98efe454`](https://github.com/someengineering/fixinventory/commit/98efe454) gcp Add SCC service collection (#2291) +- [`54024e5c`](https://github.com/someengineering/fixinventory/commit/54024e5c) gcp Improve the way of collection for DiskTypes and MachineTypes (#2284) +- [`73efbf33`](https://github.com/someengineering/fixinventory/commit/73efbf33) gcp Add Pub/Sub service collection (#2287) +- [`c6267002`](https://github.com/someengineering/fixinventory/commit/c6267002) gcp Add metrics collection (#2283) +- [`5b8dc075`](https://github.com/someengineering/fixinventory/commit/5b8dc075) lib Extend base resources with additional common properties (#2278) +- [`2cccb449`](https://github.com/someengineering/fixinventory/commit/2cccb449) aws Reimplement SSM Compliance resource collection (#2280) +- [`a18bf1af`](https://github.com/someengineering/fixinventory/commit/a18bf1af) gcp Add cloudfunctions service collection (#2276) +- [`6a681048`](https://github.com/someengineering/fixinventory/commit/6a681048) gcp Add filestore service collection (#2277) +- [`6d185bb3`](https://github.com/someengineering/fixinventory/commit/6d185bb3) gcp Add firestore service collection (#2275) +- [`897e9204`](https://github.com/someengineering/fixinventory/commit/897e9204) core Add Async Streams abstraction (#2273) +- [`309a6344`](https://github.com/someengineering/fixinventory/commit/309a6344) azure Update security assessments collection (#2266) +- [`c22f979f`](https://github.com/someengineering/fixinventory/commit/c22f979f) aws Add searching instances also by region and make `SEVERITY_MAPPING` statically (#2272) +- [`65c98f76`](https://github.com/someengineering/fixinventory/commit/65c98f76) aws Add collection of GuardDuty resource (#2255) +- [`bc8eae4a`](https://github.com/someengineering/fixinventory/commit/bc8eae4a) aws Make a collection of Ec2 Instance types only for existing instances (#2264) +- [`fc42db51`](https://github.com/someengineering/fixinventory/commit/fc42db51) lib Allow marking resource classes as not exportable (#2259) +- [`23cd836a`](https://github.com/someengineering/fixinventory/commit/23cd836a) lib Define separate assessment section (#2257) +- [`d77c65cc`](https://github.com/someengineering/fixinventory/commit/d77c65cc) aws Ignore datetime for history by default (#2256) +- [`a0083255`](https://github.com/someengineering/fixinventory/commit/a0083255) plugins/onprem Move onprem plugin to dedicated repository (#2251) +- [`1d0504ac`](https://github.com/someengineering/fixinventory/commit/1d0504ac) aws Revert "[aws][feat] Add collection of Inspector resource (#2242)" (#2246) +- [`8626219a`](https://github.com/someengineering/fixinventory/commit/8626219a) aws Add collection of Inspector resource (#2242) +- [`6cacdf95`](https://github.com/someengineering/fixinventory/commit/6cacdf95) azure : Add more connections from monitor (#2239) +- [`47a41a01`](https://github.com/someengineering/fixinventory/commit/47a41a01) plugins/vsphere Move vSphere plugin to dedicated repository (#2243) +- [`b37bc55c`](https://github.com/someengineering/fixinventory/commit/b37bc55c) azure Collect certificates from sub resources (#2225) +- [`f3a94606`](https://github.com/someengineering/fixinventory/commit/f3a94606) core Allows retrieving the model from plugins instead of db (#2232) +- [`8482aa6d`](https://github.com/someengineering/fixinventory/commit/8482aa6d) azure : Improved AzureComputeDiskTypePricing deletion (#2231) +- [`e27feda8`](https://github.com/someengineering/fixinventory/commit/e27feda8) aws Add additional policies to the cloudwatch (#2216) +- [`1022d231`](https://github.com/someengineering/fixinventory/commit/1022d231) Cleanup (#2224) +- [`25d12134`](https://github.com/someengineering/fixinventory/commit/25d12134) aws Add lifecycle policy to the S3 resource (#2220) +- [`a2853406`](https://github.com/someengineering/fixinventory/commit/a2853406) gcp Add Vertex AI collection (#2211) +- [`06ff0a3f`](https://github.com/someengineering/fixinventory/commit/06ff0a3f) azure Connect CosmosDB resources to the location instead of subscription (#2214) +- [`70e1eec9`](https://github.com/someengineering/fixinventory/commit/70e1eec9) core Add node command (#2212) +- [`4ba56c19`](https://github.com/someengineering/fixinventory/commit/4ba56c19) plugin Better docs and docs_url (#2210) +- [`14887b64`](https://github.com/someengineering/fixinventory/commit/14887b64) core Add kind description in multi tenant mode (#2204) +- [`550f6bf1`](https://github.com/someengineering/fixinventory/commit/550f6bf1) aws : Add more policies to collect (#2202) +- [`146cd102`](https://github.com/someengineering/fixinventory/commit/146cd102) core list: allow for listing props with default props (#2200) +- [`077a8086`](https://github.com/someengineering/fixinventory/commit/077a8086) core Add IAM edge collection (#2198) +- [`50ec1d35`](https://github.com/someengineering/fixinventory/commit/50ec1d35) aws Bedrock resources collection (#2190) +- [`6d11a8a9`](https://github.com/someengineering/fixinventory/commit/6d11a8a9) lib Unify groups and categories (#2194) +- [`62a867e8`](https://github.com/someengineering/fixinventory/commit/62a867e8) lib Improve model check (#2193) +- [`90139f5c`](https://github.com/someengineering/fixinventory/commit/90139f5c) hetzner Initial Hetzner Cloud support (#2168) +- [`66cbd9e3`](https://github.com/someengineering/fixinventory/commit/66cbd9e3) plugins Proper name, icon and group for AWS, Azure and GCP (#2188) +- [`36ddfa5b`](https://github.com/someengineering/fixinventory/commit/36ddfa5b) core Allow filtering edge properties (#2186) +- [`85fbe2d2`](https://github.com/someengineering/fixinventory/commit/85fbe2d2) azure Azure adjust names and connections (#2183) +- [`f7d3dac7`](https://github.com/someengineering/fixinventory/commit/f7d3dac7) core Allow edge properties (#2182) +- [`467a6638`](https://github.com/someengineering/fixinventory/commit/467a6638) core Use database locks to perform migration (#2184) +- [`c3a1bddb`](https://github.com/someengineering/fixinventory/commit/c3a1bddb) aws Add amazon Q resource collection (#2175) +- [`6be0feb2`](https://github.com/someengineering/fixinventory/commit/6be0feb2) azure Add machine learning resources collection (#2174) +- [`70cee4c5`](https://github.com/someengineering/fixinventory/commit/70cee4c5) core allowlist events for posthog (#2177) +- [`0b83034f`](https://github.com/someengineering/fixinventory/commit/0b83034f) azure Add PostgreSQL collection for cosmos-db resources (#2170) +- [`4fffcfa9`](https://github.com/someengineering/fixinventory/commit/4fffcfa9) azure Add cosmos-db resources collection (#2167) +- [`4b9b7184`](https://github.com/someengineering/fixinventory/commit/4b9b7184) azure Add WebApp (#2164) +- [`3c831f8c`](https://github.com/someengineering/fixinventory/commit/3c831f8c) azure Improve KeyVault (#2163) +- [`c06a775b`](https://github.com/someengineering/fixinventory/commit/c06a775b) core account security score details (#2162) +- [`89ffc7c4`](https://github.com/someengineering/fixinventory/commit/89ffc7c4) gcp Save parsing with feedback (#2160) +- [`34d50ba3`](https://github.com/someengineering/fixinventory/commit/34d50ba3) azure Add flow log resource collection (#2159) +- [`fdaeb537`](https://github.com/someengineering/fixinventory/commit/fdaeb537) azure Monitoring and KeyVault resources (#2156) +- [`f692309a`](https://github.com/someengineering/fixinventory/commit/f692309a) azure : Update configs collection for mysql and postgresql (#2157) +- [`3410e814`](https://github.com/someengineering/fixinventory/commit/3410e814) azure Add postgres service collection (#2155) +- [`4125af70`](https://github.com/someengineering/fixinventory/commit/4125af70) azure Improve SQL Server (#2151) +- [`3de8958f`](https://github.com/someengineering/fixinventory/commit/3de8958f) azure Add support for mysql resource collection (#2150) +- [`4f24d5ba`](https://github.com/someengineering/fixinventory/commit/4f24d5ba) core Add history timeline (#2152) +- [`a7cdc097`](https://github.com/someengineering/fixinventory/commit/a7cdc097) azure : Add prefix 'server' to the SQL resources (#2148) +- [`ea2c97fe`](https://github.com/someengineering/fixinventory/commit/ea2c97fe) azure Add policies (#2141) +- [`4f4d80eb`](https://github.com/someengineering/fixinventory/commit/4f4d80eb) azure Add support for sql resource collection (#2144) + +### Fixes + +- [`d61bb368`](https://github.com/someengineering/fixinventory/commit/d61bb368) docker-compose no pull info (#2297) +- [`0d969e4f`](https://github.com/someengineering/fixinventory/commit/0d969e4f) docker-compose -> docker compose (#2295) +- [`3fff8b57`](https://github.com/someengineering/fixinventory/commit/3fff8b57) aws : Update S3 bucket tests for updated implementation (#2281) +- [`e0c1ae7d`](https://github.com/someengineering/fixinventory/commit/e0c1ae7d) azure : Ignore errors from Azure side (#2263) +- [`ebb67bec`](https://github.com/someengineering/fixinventory/commit/ebb67bec) aws Collect and connect Inspector resources properly (#2253) +- [`2022f484`](https://github.com/someengineering/fixinventory/commit/2022f484) azure Metadata (#2261) +- [`aceca6bc`](https://github.com/someengineering/fixinventory/commit/aceca6bc) core Use id and name for descendant count (#2271) +- [`e83ee7a7`](https://github.com/someengineering/fixinventory/commit/e83ee7a7) Store access levels directly on the reported section (#2265) +- [`67091085`](https://github.com/someengineering/fixinventory/commit/67091085) core Count failing resources correctly (#2269) +- [`fee7b5a0`](https://github.com/someengineering/fixinventory/commit/fee7b5a0) Enable access_edges via env variable (#2262) +- [`d2acc740`](https://github.com/someengineering/fixinventory/commit/d2acc740) aws Ignore wrong history events (#2260) +- [`3ba74a90`](https://github.com/someengineering/fixinventory/commit/3ba74a90) Add sts:AssumeRole action when checking roles (#2244) +- [`4d6ff4a7`](https://github.com/someengineering/fixinventory/commit/4d6ff4a7) Add an access section next to permissions in IAM edges (#2254) +- [`015bbfee`](https://github.com/someengineering/fixinventory/commit/015bbfee) Make resource_policy abstract method to trigger typecheck (#2252) +- [`53b45ef1`](https://github.com/someengineering/fixinventory/commit/53b45ef1) aws Turn off access edge collection (#2248) +- [`4381b4fb`](https://github.com/someengineering/fixinventory/commit/4381b4fb) core Export property documentation for configs (#2245) +- [`20335dd2`](https://github.com/someengineering/fixinventory/commit/20335dd2) Wrap scp collection into try catch (#2241) +- [`d3c88331`](https://github.com/someengineering/fixinventory/commit/d3c88331) Enable access edges collection (#2238) +- [`42c7c446`](https://github.com/someengineering/fixinventory/commit/42c7c446) Collect SCPs for access edges (#2235) +- [`d989475c`](https://github.com/someengineering/fixinventory/commit/d989475c) aws Handle AWS server errors properly (#2236) +- [`19801757`](https://github.com/someengineering/fixinventory/commit/19801757) azure Reimplement resource type collection of compute, psql, mysql and ml services (#2234) +- [`8adf359d`](https://github.com/someengineering/fixinventory/commit/8adf359d) core Add kinds to content hash (#2233) +- [`303e661e`](https://github.com/someengineering/fixinventory/commit/303e661e) azure Define Phantom Resources (#2230) +- [`12878a16`](https://github.com/someengineering/fixinventory/commit/12878a16) aws Add missing resource docs (#2227) +- [`73218b40`](https://github.com/someengineering/fixinventory/commit/73218b40) azure Compute unused regions as last step (#2228) +- [`c6e9b82a`](https://github.com/someengineering/fixinventory/commit/c6e9b82a) Access Edges (#2195) +- [`bce4ffcb`](https://github.com/someengineering/fixinventory/commit/bce4ffcb) Better detect and remove unused regions (#2222) +- [`7f41f800`](https://github.com/someengineering/fixinventory/commit/7f41f800) core move slotted data to previous slot, not next (#2226) +- [`e0f8435b`](https://github.com/someengineering/fixinventory/commit/e0f8435b) gcp : Deduplicate error messages in accumulator (#2223) +- [`46953708`](https://github.com/someengineering/fixinventory/commit/46953708) core Merge edge and vertex and unfold in code (#2217) +- [`5aee8cbc`](https://github.com/someengineering/fixinventory/commit/5aee8cbc) core Compute descendant count based on ancestors section not g… (#2213) +- [`a5267a37`](https://github.com/someengineering/fixinventory/commit/a5267a37) azure : Fix `connect_in_graph` method of `AzureAuthorizationRoleAssignment` resource (#2215) +- [`47c62533`](https://github.com/someengineering/fixinventory/commit/47c62533) core Multipart name (#2203) +- [`5d39d027`](https://github.com/someengineering/fixinventory/commit/5d39d027) azure Ignore props for history (#2201) +- [`61e97ea3`](https://github.com/someengineering/fixinventory/commit/61e97ea3) core Traverse the graph by walking all possible paths when an edge filter is present (#2197) +- [`21ddc09a`](https://github.com/someengineering/fixinventory/commit/21ddc09a) core Persist parent update structure in an atomic way (#2196) +- [`ac8c4a08`](https://github.com/someengineering/fixinventory/commit/ac8c4a08) azure : Fix unnecessary abstract class kinds (#2191) +- [`d7fcb849`](https://github.com/someengineering/fixinventory/commit/d7fcb849) plugins Add missing metadata (#2192) +- [`e44bb355`](https://github.com/someengineering/fixinventory/commit/e44bb355) core Fix model filter condition (#2189) +- [`2b99e41a`](https://github.com/someengineering/fixinventory/commit/2b99e41a) Add IamPrincipal base resource (#2187) +- [`f11d8717`](https://github.com/someengineering/fixinventory/commit/f11d8717) core Surrogate system data (#2185) +- [`16df325e`](https://github.com/someengineering/fixinventory/commit/16df325e) core arangosearch predicates with array access (#2179) +- [`9256dace`](https://github.com/someengineering/fixinventory/commit/9256dace) core Do not use arangosearch for nested array context searches (#2178) +- [`d4f3a035`](https://github.com/someengineering/fixinventory/commit/d4f3a035) core latest azure check (#2172) +- [`e0008e56`](https://github.com/someengineering/fixinventory/commit/e0008e56) Make report checks lookup safer (#2171) +- [`89cf8177`](https://github.com/someengineering/fixinventory/commit/89cf8177) core History timeseries slotter (#2169) +- [`00b95816`](https://github.com/someengineering/fixinventory/commit/00b95816) gcp : Duplicate checksum error in sql service (#2166) +- [`59e53ccb`](https://github.com/someengineering/fixinventory/commit/59e53ccb) core Move timeline to request time after (#2165) +- [`dcd08d96`](https://github.com/someengineering/fixinventory/commit/dcd08d96) gcp Improve error message (#2161) +- [`2278030e`](https://github.com/someengineering/fixinventory/commit/2278030e) core Use consistent reading when updating the account (#2158) +- [`c8bb7918`](https://github.com/someengineering/fixinventory/commit/c8bb7918) gcp Disk size types (#2154) +- [`57a7d38c`](https://github.com/someengineering/fixinventory/commit/57a7d38c) shell Do not warn when the model cannot be loaded (#2153) +- [`0c4ee17a`](https://github.com/someengineering/fixinventory/commit/0c4ee17a) azure Better names (#2149) +- [`73486084`](https://github.com/someengineering/fixinventory/commit/73486084) core Security sync by always marking the resource vulnerable (#2147) +- [`4f0f9734`](https://github.com/someengineering/fixinventory/commit/4f0f9734) core History search with sort and fulltext terms (#2146) +- [`c710cf6e`](https://github.com/someengineering/fixinventory/commit/c710cf6e) core Fix nested with statements (#2145) + +### Documentation + +- [`786318ae`](https://github.com/someengineering/fixinventory/commit/786318ae) Update README.md fix Get Started Guide Link (Fixes: 2285 https://github.com/someengineering/fixinventory/issues/2285) (#2286) +- [`a42fa7ea`](https://github.com/someengineering/fixinventory/commit/a42fa7ea) Update README.md (#2250) +- [`732e13fa`](https://github.com/someengineering/fixinventory/commit/732e13fa) Added images to README.md (#2249) +- [`a6afc70a`](https://github.com/someengineering/fixinventory/commit/a6afc70a) Update README.md with details (#2247) +- [`68c61523`](https://github.com/someengineering/fixinventory/commit/68c61523) Update Link in overview of README.md (#2173) + +### Chores + +- [`07e0ded1`](https://github.com/someengineering/fixinventory/commit/07e0ded1) Bump libs (#2293) +- [`4c981891`](https://github.com/someengineering/fixinventory/commit/4c981891) Bump version (#2292) +- [`48a3e691`](https://github.com/someengineering/fixinventory/commit/48a3e691) Use PostHog default host (#2290) +- [`43a1200a`](https://github.com/someengineering/fixinventory/commit/43a1200a) Adjust Code-Owners (#2288) +- [`bbd5b4f2`](https://github.com/someengineering/fixinventory/commit/bbd5b4f2) Bump libs (#2282) +- [`aeeee140`](https://github.com/someengineering/fixinventory/commit/aeeee140) Bump Libs (#2279) +- [`f960bd8c`](https://github.com/someengineering/fixinventory/commit/f960bd8c) Bump libs (#2270) +- [`a0d35cb6`](https://github.com/someengineering/fixinventory/commit/a0d35cb6) plugins/posthog Log conversion errors (#2268) +- [`381f8a11`](https://github.com/someengineering/fixinventory/commit/381f8a11) Remove unused gitignore entries (#2267) +- [`b9595dd9`](https://github.com/someengineering/fixinventory/commit/b9595dd9) Bump fixcompliance to latest +- [`84f055d0`](https://github.com/someengineering/fixinventory/commit/84f055d0) Add a link to contribution guidelines (#2237) +- [`5f83fed3`](https://github.com/someengineering/fixinventory/commit/5f83fed3) Recreate requirements (#2229) +- [`6f8a26bf`](https://github.com/someengineering/fixinventory/commit/6f8a26bf) Bump Libs (#2221) +- [`207397fa`](https://github.com/someengineering/fixinventory/commit/207397fa) Move to Python 3.12 (#2219) +- [`0dd8f240`](https://github.com/someengineering/fixinventory/commit/0dd8f240) lib Rename internal properties with underscore (#2209) +- [`3136b95c`](https://github.com/someengineering/fixinventory/commit/3136b95c) lib Dedicated property for provider_link (#2208) +- [`0c2bc07e`](https://github.com/someengineering/fixinventory/commit/0c2bc07e) Remove phantom property (#2207) +- [`634d5275`](https://github.com/someengineering/fixinventory/commit/634d5275) azure Adjust service names (#2205) +- [`1735b141`](https://github.com/someengineering/fixinventory/commit/1735b141) Bump Libs (#2199) +- [`fe600472`](https://github.com/someengineering/fixinventory/commit/fe600472) Bump fixcompliance to latest +- [`33eff4dd`](https://github.com/someengineering/fixinventory/commit/33eff4dd) Bump fixcompliance to latest +- [`a0efd4ff`](https://github.com/someengineering/fixinventory/commit/a0efd4ff) aws Documentation for AWS Iam and SSO (#2181) +- [`7cda2327`](https://github.com/someengineering/fixinventory/commit/7cda2327) azure Remove unused classes (#2180) +- [`bdc974a1`](https://github.com/someengineering/fixinventory/commit/bdc974a1) Bump libs (#2176) +- [`3b3c4cf2`](https://github.com/someengineering/fixinventory/commit/3b3c4cf2) Bump fixcompliance to latest +- [`d87f9f89`](https://github.com/someengineering/fixinventory/commit/d87f9f89) Bump fixcompliance to latest +- [`5e3bc854`](https://github.com/someengineering/fixinventory/commit/5e3bc854) Bump fixcompliance to latest +- [`3b7af84a`](https://github.com/someengineering/fixinventory/commit/3b7af84a) Bump fixcompliance to latest +- [`1c939020`](https://github.com/someengineering/fixinventory/commit/1c939020) Bump fixcompliance to latest + +### feature + +- [`76f1e08c`](https://github.com/someengineering/fixinventory/commit/76f1e08c) lib Add the source of resource kind (#2218) + +{/* truncate */} + +## Docker Images + +- `somecr.io/someengineering/fixcore:4.2.0` +- `somecr.io/someengineering/fixworker:4.2.0` +- `somecr.io/someengineering/fixshell:4.2.0` +- `somecr.io/someengineering/fixmetrics:4.2.0` diff --git a/static/img/kroki/70c56643a1daf905379e928aabccce31.svg b/static/img/kroki/70c56643a1daf905379e928aabccce31.svg deleted file mode 100644 index 67c9f57f..00000000 --- a/static/img/kroki/70c56643a1daf905379e928aabccce31.svg +++ /dev/null @@ -1 +0,0 @@ -access_keyaccountai_jobai_modelai_resourceautoscaling_groupaws_accountaws_acm_certificateaws_albaws_alb_target_groupaws_apigateway_authorizeraws_apigateway_deploymentaws_apigateway_domain_nameaws_apigateway_resourceaws_apigateway_rest_apiaws_apigateway_stageaws_athena_data_catalogaws_athena_work_groupaws_autoscaling_groupaws_backup_copy_jobaws_backup_frameworkaws_backup_jobaws_backup_legal_holdaws_backup_planaws_backup_protected_resourceaws_backup_recovery_pointaws_backup_report_planaws_backup_restore_jobaws_backup_restore_testing_planaws_backup_vaultaws_beanstalk_applicationaws_beanstalk_environmentaws_bedrock_agentaws_bedrock_agent_flowaws_bedrock_agent_flow_versionaws_bedrock_agent_knowledge_baseaws_bedrock_agent_promptaws_bedrock_custom_modelaws_bedrock_evaluation_jobaws_bedrock_foundation_modelaws_bedrock_guardrailaws_bedrock_model_customization_jobaws_bedrock_provisioned_model_throughputaws_cloud_formation_stack_instance_summaryaws_cloud_trailaws_cloudformation_stackaws_cloudformation_stack_setaws_cloudfront_cache_policyaws_cloudfront_distributionaws_cloudfront_field_level_encryption_configaws_cloudfront_field_level_encryption_profileaws_cloudfront_functionaws_cloudfront_origin_access_controlaws_cloudfront_public_keyaws_cloudfront_realtime_log_configaws_cloudfront_response_headers_policyaws_cloudfront_streaming_distributionaws_cloudwatch_alarmaws_cloudwatch_log_groupaws_cloudwatch_metric_filteraws_cognito_groupaws_cognito_useraws_cognito_user_poolaws_config_recorderaws_dynamodb_global_tableaws_dynamodb_tableaws_ec2_elastic_ipaws_ec2_flow_logaws_ec2_hostaws_ec2_imageaws_ec2_instanceaws_ec2_instance_typeaws_ec2_internet_gatewayaws_ec2_keypairaws_ec2_launch_templateaws_ec2_nat_gatewayaws_ec2_network_aclaws_ec2_network_interfaceaws_ec2_reserved_instancesaws_ec2_route_tableaws_ec2_security_groupaws_ec2_snapshotaws_ec2_subnetaws_ec2_volumeaws_ec2_volume_typeaws_ecr_repositoryaws_ecs_capacity_provideraws_ecs_clusteraws_ecs_container_instanceaws_ecs_serviceaws_ecs_taskaws_ecs_task_definitionaws_efs_access_pointaws_efs_file_systemaws_efs_mount_targetaws_eks_clusteraws_eks_nodegroupaws_elasticache_cache_clusteraws_elasticache_replication_groupaws_elbaws_glacier_jobaws_glacier_vaultaws_iam_access_keyaws_iam_groupaws_iam_instance_profileaws_iam_policyaws_iam_roleaws_iam_server_certificateaws_iam_useraws_kinesis_streamaws_kms_keyaws_lambda_functionaws_opensearch_domainaws_organizational_rootaws_organizational_unitaws_q_appsaws_q_apps_library_itemaws_q_business_applicationaws_q_business_conversationaws_q_business_data_sourceaws_q_business_data_source_sync_jobaws_q_business_documentaws_q_business_indiceaws_q_business_messageaws_q_business_pluginaws_q_business_retrieveraws_q_business_web_experienceaws_rds_clusteraws_rds_cluster_snapshotaws_rds_instanceaws_rds_snapshotaws_redshift_clusteraws_regionaws_resourceaws_root_useraws_route53_resource_recordaws_route53_resource_record_setaws_route53_zoneaws_s3_account_settingsaws_s3_bucketaws_sagemaker_algorithmaws_sagemaker_appaws_sagemaker_artifactaws_sagemaker_auto_ml_jobaws_sagemaker_code_repositoryaws_sagemaker_compilation_jobaws_sagemaker_domainaws_sagemaker_endpointaws_sagemaker_experimentaws_sagemaker_hyper_parameter_tuning_jobaws_sagemaker_imageaws_sagemaker_inference_recommendations_jobaws_sagemaker_jobaws_sagemaker_labeling_jobaws_sagemaker_modelaws_sagemaker_notebookaws_sagemaker_pipelineaws_sagemaker_processing_jobaws_sagemaker_projectaws_sagemaker_training_jobaws_sagemaker_transform_jobaws_sagemaker_trialaws_sagemaker_user_profileaws_sagemaker_workteamaws_secretsmanager_secretaws_service_quotaaws_sns_endpointaws_sns_platform_applicationaws_sns_subscriptionaws_sns_topicaws_sqs_queueaws_ssm_documentaws_ssm_instanceaws_vpcaws_vpc_endpointaws_vpc_peering_connectionaws_waf_web_aclazure_authorization_deny_assignmentazure_authorization_management_lockazure_authorization_role_assignmentazure_authorization_role_definitionazure_compute_availability_setazure_compute_capacity_reservation_groupazure_compute_cloud_serviceazure_compute_dedicated_host_groupazure_compute_diskazure_compute_disk_accessazure_compute_disk_encryption_setazure_compute_disk_typeazure_compute_disk_type_pricingazure_compute_galleryazure_compute_imageazure_compute_proximity_placement_groupazure_compute_restore_point_collectionazure_compute_ssh_public_keyazure_compute_virtual_machineazure_compute_virtual_machine_baseazure_compute_virtual_machine_scale_setazure_compute_virtual_machine_scale_set_instanceazure_compute_virtual_machine_sizeazure_compute_virtual_machine_snapshotazure_container_service_fleetazure_container_service_managed_clusterazure_container_service_managed_cluster_snapshotazure_cosmos_db_accountazure_cosmos_db_account_usageazure_cosmos_db_cassandra_clusterazure_cosmos_db_cassandra_cluster_data_centerazure_cosmos_db_cassandra_cluster_public_statusazure_cosmos_db_cassandra_keyspaceazure_cosmos_db_cassandra_tableazure_cosmos_db_gremlin_databaseazure_cosmos_db_gremlin_graphazure_cosmos_db_locationazure_cosmos_db_mongo_db_clusterazure_cosmos_db_mongo_db_collectionazure_cosmos_db_mongo_db_databaseazure_cosmos_db_mongo_db_role_definitionazure_cosmos_db_mongo_db_user_definitionazure_cosmos_db_notebook_workspaceazure_cosmos_db_postgresql_clusterazure_cosmos_db_postgresql_cluster_configurationazure_cosmos_db_postgresql_cluster_private_endpoint_connectionazure_cosmos_db_postgresql_cluster_private_linkazure_cosmos_db_postgresql_cluster_roleazure_cosmos_db_postgresql_cluster_serverazure_cosmos_db_postgresql_cluster_server_configurationazure_cosmos_db_private_linkazure_cosmos_db_restorable_accountazure_cosmos_db_restorable_gremlin_databaseazure_cosmos_db_restorable_gremlin_graphazure_cosmos_db_restorable_mongo_db_collectionazure_cosmos_db_restorable_mongo_db_databaseazure_cosmos_db_restorable_sql_containerazure_cosmos_db_restorable_sql_databaseazure_cosmos_db_restorable_tableazure_cosmos_db_sql_databaseazure_cosmos_db_sql_database_client_encryption_keyazure_cosmos_db_sql_database_containerazure_cosmos_db_sql_role_assignmentazure_cosmos_db_sql_role_definitionazure_cosmos_db_sql_throughput_settingazure_cosmos_db_tableazure_key_vaultazure_key_vault_keyazure_key_vault_managed_hsmazure_key_vault_secretazure_locationazure_machine_learning_batch_endpointazure_machine_learning_computeazure_machine_learning_compute_nodeazure_machine_learning_datastoreazure_machine_learning_endpointazure_machine_learning_environment_version_baseazure_machine_learning_featureazure_machine_learning_featureset_containerazure_machine_learning_featureset_versionazure_machine_learning_featurestore_entity_containerazure_machine_learning_featurestore_entity_versionazure_machine_learning_jobazure_machine_learning_labeling_jobazure_machine_learning_online_endpointazure_machine_learning_private_endpoint_connectionazure_machine_learning_private_linkazure_machine_learning_quotaazure_machine_learning_registryazure_machine_learning_registry_code_containerazure_machine_learning_registry_code_versionazure_machine_learning_registry_component_containerazure_machine_learning_registry_component_versionazure_machine_learning_registry_data_containerazure_machine_learning_registry_data_versionazure_machine_learning_registry_environment_containerazure_machine_learning_registry_environment_versionazure_machine_learning_registry_model_containerazure_machine_learning_registry_model_versionazure_machine_learning_scheduleazure_machine_learning_serverless_endpointazure_machine_learning_usageazure_machine_learning_virtual_machine_sizeazure_machine_learning_workspaceazure_machine_learning_workspace_code_containerazure_machine_learning_workspace_code_versionazure_machine_learning_workspace_component_containerazure_machine_learning_workspace_component_versionazure_machine_learning_workspace_connectionazure_machine_learning_workspace_data_containerazure_machine_learning_workspace_data_versionazure_machine_learning_workspace_environment_containerazure_machine_learning_workspace_environment_versionazure_machine_learning_workspace_model_containerazure_machine_learning_workspace_model_versionazure_monitor_action_groupazure_monitor_activity_log_alertazure_monitor_data_collection_ruleazure_monitor_diagnostic_settingsazure_monitor_log_profileazure_monitor_metric_alertazure_monitor_pipeline_groupazure_monitor_private_link_scopeazure_monitor_scheduled_query_ruleazure_monitor_workspaceazure_mysql_serverazure_mysql_server_ad_administratorazure_mysql_server_backupazure_mysql_server_configurationazure_mysql_server_databaseazure_mysql_server_firewall_ruleazure_mysql_server_log_fileazure_mysql_server_maintenanceazure_mysql_server_typeazure_network_application_gatewayazure_network_application_gateway_authentication_certificateazure_network_application_gateway_firewall_rule_setazure_network_application_gateway_ssl_certificateazure_network_application_gateway_trusted_client_certificateazure_network_application_gateway_trusted_root_certificateazure_network_bastion_hostazure_network_custom_ip_prefixazure_network_ddos_protection_planazure_network_dns_record_setazure_network_dns_zoneazure_network_dscp_configurationazure_network_express_route_circuitazure_network_express_route_cross_connectionazure_network_express_route_gatewayazure_network_express_route_portazure_network_express_route_ports_locationazure_network_firewallazure_network_firewall_policyazure_network_flow_logazure_network_interfaceazure_network_ip_allocationazure_network_ip_groupazure_network_load_balancerazure_network_load_balancer_probeazure_network_local_network_gatewayazure_network_nat_gatewayazure_network_p2_s_vpn_gatewayazure_network_private_link_serviceazure_network_profileazure_network_public_ip_addressazure_network_public_ip_prefixazure_network_route_filterazure_network_route_tableazure_network_security_groupazure_network_security_partner_providerazure_network_subnetazure_network_usageazure_network_virtual_applianceazure_network_virtual_appliance_skuazure_network_virtual_hubazure_network_virtual_networkazure_network_virtual_network_gatewayazure_network_virtual_network_gateway_connectionazure_network_virtual_network_tapazure_network_virtual_routerazure_network_virtual_wanazure_network_virtual_wan_vpn_connectionazure_network_virtual_wan_vpn_gatewayazure_network_vpn_client_revoked_certificateazure_network_vpn_client_root_certificateazure_network_vpn_server_configurationazure_network_vpn_siteazure_network_watcherazure_network_web_application_firewall_policyazure_postgresql_ad_administratorazure_postgresql_serverazure_postgresql_server_backupazure_postgresql_server_configurationazure_postgresql_server_databaseazure_postgresql_server_firewall_ruleazure_postgresql_server_typeazure_resource_groupazure_security_auto_provisioning_settingazure_security_pricingazure_security_server_vulnerability_assessments_settingazure_security_settingazure_sql_serverazure_sql_server_ad_administratorazure_sql_server_advisorazure_sql_server_databaseazure_sql_server_database_geo_backup_policyazure_sql_server_database_workload_groupazure_sql_server_elastic_poolazure_sql_server_failover_groupazure_sql_server_firewall_ruleazure_sql_server_job_agentazure_sql_server_managed_instanceazure_sql_server_managed_instance_ad_administratorazure_sql_server_managed_instance_databaseazure_sql_server_managed_instance_failover_groupazure_sql_server_managed_instance_poolazure_sql_server_trust_groupazure_sql_server_virtual_clusterazure_sql_server_virtual_network_ruleazure_storage_accountazure_storage_account_deletedazure_storage_account_usageazure_storage_blob_containerazure_storage_file_shareazure_storage_queueazure_storage_skuazure_storage_tableazure_subscriptionazure_usageazure_web_appazure_web_app_service_planazure_web_app_static_siteazure_web_certificateazure_web_container_appazure_web_domainazure_web_hosting_environmentazure_web_kube_environmentbase_cloudbucketbucket_quotacertificatecertificate_quotaclouddatabasedatabase_instance_typedigitalocean_alert_policydigitalocean_appdigitalocean_cdn_endpointdigitalocean_certificatedigitalocean_container_registrydigitalocean_container_registry_repositorydigitalocean_container_registry_repository_tagdigitalocean_databasedigitalocean_domaindigitalocean_domain_recorddigitalocean_dropletdigitalocean_droplet_neighborhooddigitalocean_droplet_sizedigitalocean_firewalldigitalocean_floating_ipdigitalocean_imagedigitalocean_kubernetes_clusterdigitalocean_load_balancerdigitalocean_projectdigitalocean_regiondigitalocean_resourcedigitalocean_snapshotdigitalocean_spacedigitalocean_ssh_keydigitalocean_teamdigitalocean_volumedigitalocean_vpcdns_recorddns_record_setdns_zonedockerhub_namespacedockerhub_repositoryendpointfirewallgatewaygateway_quotagcp_accelerator_typegcp_addressgcp_autoscalergcp_backend_bucketgcp_backend_servicegcp_billing_accountgcp_bucketgcp_cloud_functiongcp_commitmentgcp_container_clustergcp_container_operationgcp_diskgcp_disk_typegcp_external_vpn_gatewaygcp_filestore_backupgcp_filestore_instancegcp_filestore_instance_snapshotgcp_firestore_backupgcp_firestore_databasegcp_firestore_documentgcp_firewallgcp_firewall_policygcp_forwarding_rulegcp_health_checkgcp_health_check_servicegcp_http_health_checkgcp_https_health_checkgcp_imagegcp_instancegcp_instance_groupgcp_instance_group_managergcp_instance_templategcp_interconnectgcp_interconnect_attachmentgcp_interconnect_locationgcp_licensegcp_machine_imagegcp_machine_typegcp_networkgcp_network_edge_security_servicegcp_network_endpoint_groupgcp_node_groupgcp_node_templategcp_node_typegcp_notification_endpointgcp_objectgcp_operationgcp_packet_mirroringgcp_projectgcp_project_billing_infogcp_public_advertised_prefixgcp_public_delegated_prefixgcp_pubsub_snapshotgcp_pubsub_subscriptiongcp_pubsub_topicgcp_regiongcp_region_quotagcp_resourcegcp_resource_policygcp_routegcp_routergcp_security_policygcp_servicegcp_service_attachmentgcp_skugcp_snapshotgcp_sql_backup_rungcp_sql_databasegcp_sql_database_instancegcp_sql_operationgcp_sql_usergcp_ssl_certificategcp_ssl_policygcp_subnetworkgcp_target_grpc_proxygcp_target_http_proxygcp_target_https_proxygcp_target_instancegcp_target_poolgcp_target_ssl_proxygcp_target_tcp_proxygcp_target_vpn_gatewaygcp_url_mapgcp_vertex_ai_batch_prediction_jobgcp_vertex_ai_custom_jobgcp_vertex_ai_datasetgcp_vertex_ai_dataset_versiongcp_vertex_ai_endpointgcp_vertex_ai_featuregcp_vertex_ai_feature_groupgcp_vertex_ai_featurestoregcp_vertex_ai_hyperparameter_tuning_jobgcp_vertex_ai_indexgcp_vertex_ai_index_endpointgcp_vertex_ai_modelgcp_vertex_ai_model_deployment_monitoring_jobgcp_vertex_ai_model_evaluationgcp_vertex_ai_pipeline_jobgcp_vertex_ai_schedulegcp_vertex_ai_tensorboardgcp_vertex_ai_training_pipelinegcp_vertex_ai_tuning_jobgcp_vpn_gatewaygcp_vpn_tunnelgcp_zonegithub_accountgithub_orggithub_pull_requestgithub_regiongithub_repogithub_usergrouphealth_checkiam_principalinstanceinstance_profileinstance_quotainstance_typeip_addresskeypairkubernetes_clusterkubernetes_cluster_rolekubernetes_cluster_role_bindingkubernetes_config_mapkubernetes_controller_revisionkubernetes_cron_jobkubernetes_csi_driverkubernetes_csi_nodekubernetes_csi_storage_capacitykubernetes_daemon_setkubernetes_deploymentkubernetes_endpointkubernetes_endpoint_slicekubernetes_flow_schemakubernetes_horizontal_pod_autoscalerkubernetes_ingresskubernetes_ingress_classkubernetes_jobkubernetes_limit_rangekubernetes_mutating_webhook_configurationkubernetes_namespacekubernetes_network_policykubernetes_nodekubernetes_persistent_volumekubernetes_persistent_volume_claimkubernetes_podkubernetes_pod_disruption_budgetkubernetes_pod_templatekubernetes_priority_classkubernetes_priority_level_configurationkubernetes_replica_setkubernetes_replication_controllerkubernetes_resourcekubernetes_resource_quotakubernetes_rolekubernetes_role_bindingkubernetes_runtime_classkubernetes_secretkubernetes_servicekubernetes_service_accountkubernetes_stateful_setkubernetes_storage_classkubernetes_validating_webhook_configurationkubernetes_volume_attachmentload_balancerload_balancer_quotamanaged_kubernetes_cluster_providermicrosoft_graph_devicemicrosoft_graph_entitymicrosoft_graph_groupmicrosoft_graph_organizationmicrosoft_graph_organization_rootmicrosoft_graph_policymicrosoft_graph_rolemicrosoft_graph_service_principalmicrosoft_graph_usermicrosoft_resourcenetworknetwork_aclnetwork_interfacenetwork_quotanetwork_shareonelogin_accountonelogin_regiononelogin_userorganizational_rootorganizational_unitpeering_connectionphantom_resourcepolicyposthog_eventposthog_projectqueuequotaregionresourceage: durationatime: datetimectime: datetimeid: stringkind: stringlast_access: durationlast_update: durationmtime: datetimename: stringtags: dictionary[string, string]rolerouterouting_tablescarf_organizationscarf_packagesecurity_groupserverless_functionslack_conversationslack_regionslack_teamslack_userslack_usergroupsnapshotstacksubnettunneltypeuservolumevolume_typezone \ No newline at end of file diff --git a/static/img/kroki/d5898aef8ce5ff4ba6182cdf7ac1803f.svg b/static/img/kroki/d5898aef8ce5ff4ba6182cdf7ac1803f.svg deleted file mode 100644 index 01232c5d..00000000 --- a/static/img/kroki/d5898aef8ce5ff4ba6182cdf7ac1803f.svg +++ /dev/null @@ -1 +0,0 @@ -aws_ec2_instance_typeaws_ec2_volume_typeaws_regionaws_s3_account_settingsaws_service_quotaazure_authorization_role_definitionazure_compute_disk_typeazure_compute_virtual_machine_sizeazure_cosmos_db_account_usageazure_cosmos_db_locationazure_locationazure_machine_learning_environment_version_baseazure_machine_learning_quotaazure_machine_learning_registry_environment_versionazure_machine_learning_usageazure_machine_learning_virtual_machine_sizeazure_machine_learning_workspace_environment_versionazure_mysql_server_typeazure_network_application_gateway_firewall_rule_setazure_network_express_route_ports_locationazure_network_security_partner_providerazure_network_usageazure_network_virtual_appliance_skuazure_postgresql_server_typeazure_security_pricingazure_storage_account_deletedazure_storage_account_usageazure_storage_skuazure_usagebase_cloudbucket_quotacertificate_quotaclouddatabase_instance_typedigitalocean_droplet_neighborhooddigitalocean_droplet_sizedigitalocean_regiongateway_quotagcp_disk_typegcp_interconnect_locationgcp_machine_typegcp_regiongcp_region_quotagcp_zonegithub_regioninstance_quotainstance_typekubernetes_namespacekubernetes_resource_quotaload_balancer_quotamicrosoft_graph_organization_rootnetwork_quotaonelogin_regionphantom_resourcequotaregionresourceage: durationatime: datetimectime: datetimeid: stringkind: stringlast_access: durationlast_update: durationmtime: datetimename: stringtags: dictionary[string, string]slack_regiontypevolume_typezone \ No newline at end of file diff --git a/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model.api.mdx b/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model.api.mdx index acf3211f..78936874 100644 --- a/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model.api.mdx @@ -5,7 +5,7 @@ description: "Get the currently defined model." sidebar_label: "Get the currently defined model." hide_title: true hide_table_of_contents: true -api: {"tags":["model"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}},{"name":"kind","description":"Only return information about the defined kinds. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"filter","description":"Only return information about kinds that include given string. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"with_bases","description":"Render all base classes. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}},{"name":"format","description":"The format of the returned json","in":"query","schema":{"type":"string","enum":["schema","simple"]},"required":false},{"name":"with_property_kinds","description":"Render types of property values. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The list of all kinds.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}}},"description":"Get the currently defined model.","method":"get","path":"/graph/{graph_id}/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the currently defined model.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","model"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","type":"text/plain"},"key":"flat","value":""},{"disabled":false,"description":{"content":"Only return information about the defined kinds. Comma separated list.","type":"text/plain"},"key":"kind","value":""},{"disabled":false,"description":{"content":"Only return information about kinds that include given string. Comma separated list.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Render all base classes. Only together with kind or filter","type":"text/plain"},"key":"with_bases","value":""},{"disabled":false,"description":{"content":"The format of the returned json","type":"text/plain"},"key":"format","value":""},{"disabled":false,"description":{"content":"Render types of property values. Only together with kind or filter","type":"text/plain"},"key":"with_property_kinds","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["model"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}},{"name":"format","description":"The format of the returned json","in":"query","schema":{"type":"string","enum":["schema","simple"]},"required":false},{"name":"kind","description":"Only return information about the defined kinds. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"filter","description":"Only return information about kinds that include given string. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"aggregate_roots_only","description":"Only return aggregate roots.","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_bases","description":"Include base classes and render the base section","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_property_kinds","description":"Render types of property values. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_properties","description":"Render the properties of complex kinds","in":"query","schema":{"type":"boolean","default":true}},{"name":"with_relatives","description":"Include information about relationships to other kinds.","in":"query","schema":{"type":"boolean","default":true}},{"name":"with_metadata","description":"Include metadata information.","in":"query","schema":{"oneOf":[{"type":"boolean","description":"If true, all metadata is included."},{"type":"array","description":"List of metadata keys to include.","items":{"type":"string"}}],"default":true}}],"responses":{"200":{"description":"The list of all kinds.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}}},"description":"Get the currently defined model.","method":"get","path":"/graph/{graph_id}/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the currently defined model.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","model"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","type":"text/plain"},"key":"flat","value":""},{"disabled":false,"description":{"content":"The format of the returned json","type":"text/plain"},"key":"format","value":""},{"disabled":false,"description":{"content":"Only return information about the defined kinds. Comma separated list.","type":"text/plain"},"key":"kind","value":""},{"disabled":false,"description":{"content":"Only return information about kinds that include given string. Comma separated list.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Only return aggregate roots.","type":"text/plain"},"key":"aggregate_roots_only","value":""},{"disabled":false,"description":{"content":"Include base classes and render the base section","type":"text/plain"},"key":"with_bases","value":""},{"disabled":false,"description":{"content":"Render types of property values. Only together with kind or filter","type":"text/plain"},"key":"with_property_kinds","value":""},{"disabled":false,"description":{"content":"Render the properties of complex kinds","type":"text/plain"},"key":"with_properties","value":""},{"disabled":false,"description":{"content":"Include information about relationships to other kinds.","type":"text/plain"},"key":"with_relatives","value":""},{"disabled":false,"description":{"content":"Include metadata information.","type":"text/plain"},"key":"with_metadata","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -95,6 +95,11 @@ Get the currently defined model. param={{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}}} > + + + + + + + + diff --git a/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 c2d76501..3f45cc40 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-05T16:52:09.633Z","end":"2024-12-05T16:52:09.633Z","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-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"}}}}} sidebar_class_name: "post api-method" info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null diff --git a/versioned_docs/version-4.X/reference/api/search-all-history-events-and-return-them.api.mdx b/versioned_docs/version-4.X/reference/api/search-all-history-events-and-return-them.api.mdx index bfedc009..6d9ae0dc 100644 --- a/versioned_docs/version-4.X/reference/api/search-all-history-events-and-return-them.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-all-history-events-and-return-them.api.mdx @@ -5,7 +5,7 @@ description: "Search all history events and return them." sidebar_label: "Search all history events and return them." hide_title: true hide_table_of_contents: true -api: {"description":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"before","in":"query","description":"Optional parameter to get all history events before the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Optional parameter to get all history events after the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(volume) and reported.volume_size>100"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"}}}},"method":"post","path":"/graph/{graph_id}/search/history/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search all history events and return them.","description":{"content":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"before","in":"query","description":"Optional parameter to get all history events before the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Optional parameter to get all history events after the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(volume) and reported.volume_size>100"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"}}}},"method":"post","path":"/graph/{graph_id}/search/history/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search all history events and return them.","description":{"content":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -379,7 +379,7 @@ Search all history events and return them. A section can be defined (defaults to value={"Example"} > @@ -425,7 +425,7 @@ Search all history events and return them. A section can be defined (defaults to value={"Example"} > diff --git a/versioned_docs/version-4.X/reference/api/search-history-events-and-provide-the-number-of-events-over-time.api.mdx b/versioned_docs/version-4.X/reference/api/search-history-events-and-provide-the-number-of-events-over-time.api.mdx new file mode 100644 index 00000000..98f7790e --- /dev/null +++ b/versioned_docs/version-4.X/reference/api/search-history-events-and-provide-the-number-of-events-over-time.api.mdx @@ -0,0 +1,243 @@ +--- +id: search-history-events-and-provide-the-number-of-events-over-time +title: "Search history events and provide the number of events over time." +description: "Search all history events and a histogram over time." +sidebar_label: "Search history events and provide the number of events over time." +hide_title: true +hide_table_of_contents: true +api: {"description":"Search all history events and a histogram over time.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"before","in":"query","description":"Count all history events before the given timestamp","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Count all history events after the given timestamp","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"granularity","in":"query","description":"Optional parameter to define the granularity of the timeline","required":false,"schema":{"type":"string","format":"duration"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(volume) and reported.volume_size>100"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"example":"[\n { \"at\": \"2024-07-14T00:00:00.000Z\", \"group\": { \"change\": \"node_created\" }, \"v\": 170 },\n { \"at\": \"2024-07-15T00:00:00.000Z\", \"group\": { \"change\": \"node_updated\" }, \"v\": 833 },\n { \"at\": \"2024-07-15T00:00:00.000Z\", \"group\": { \"change\": \"node_created\" }, \"v\": 1166 }\n]\n"}}}},"method":"post","path":"/graph/{graph_id}/search/history/timeline","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search history events and provide the number of events over time.","description":{"content":"Search all history events and a histogram over time.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","timeline"],"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":"(Required) Count all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"(Required) Count all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to define the granularity of the timeline","type":"text/plain"},"key":"granularity","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","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: version-4.X/reference/api/fix-inventory-core-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import Heading from "@theme/Heading"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + + + + + + + + +Search all history events and a histogram over time. A section can be defined (defaults to `/` == root) to interpret relative property paths. Example: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2) + + + + +
+ +

+ Path Parameters +

+
+
    + + + +
+
+
+ +

+ Query Parameters +

+
+
    + + + + + + + + + + + +
+
+
+ +
+ +

+ Body +

+
+
+ + + The search to perform + + +
+
    +
    + + + string + + +
    +
+
+ +
+
+ + +
+ + + The result of this search in the defined format + + +
+ + + + +
+ + + Schema + +
+ +
    + any +
+
+ + + + + + + + +
+ + +
+
diff --git a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx index 827883ff..69d3e300 100644 --- a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx @@ -5,7 +5,7 @@ description: "Search the graph and return the matching nodes as list." sidebar_label: "Search the graph and return all nodes as list (this will not contain any edges)" hide_title: true hide_table_of_contents: true -api: {"description":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return all nodes as list (this will not contain any edges)","description":{"content":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return all nodes as list (this will not contain any edges)","description":{"content":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -364,7 +364,7 @@ Search the graph and return the matching nodes as list. A section can be defined value={"Example"} > @@ -410,7 +410,7 @@ Search the graph and return the matching nodes as list. A section can be defined value={"Example"} > diff --git a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx index c2f44011..8e4afe33 100644 --- a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx @@ -5,7 +5,7 @@ description: "Search the graph and return the matching nodes including the trave sidebar_label: "Search the graph and return the resulting graph." hide_title: true hide_table_of_contents: true -api: {"description":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"search_timeout","in":"query","description":"Optional duration the search is allowed to run.","required":false,"schema":{"type":"string","example":"30s"}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/graph","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return the resulting graph.","description":{"content":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","graph"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional duration the search is allowed to run.","type":"text/plain"},"key":"search_timeout","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"search_timeout","in":"query","description":"Optional duration the search is allowed to run.","required":false,"schema":{"type":"string","example":"30s"}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/graph","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return the resulting graph.","description":{"content":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","graph"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional duration the search is allowed to run.","type":"text/plain"},"key":"search_timeout","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -369,7 +369,7 @@ Search the graph and return the matching nodes including the traversed edges. Th value={"Example"} > @@ -415,7 +415,7 @@ Search the graph and return the matching nodes including the traversed edges. Th value={"Example"} > diff --git a/versioned_docs/version-4.X/reference/api/sidebar.ts b/versioned_docs/version-4.X/reference/api/sidebar.ts index c7ff17cf..2132aa4c 100644 --- a/versioned_docs/version-4.X/reference/api/sidebar.ts +++ b/versioned_docs/version-4.X/reference/api/sidebar.ts @@ -46,6 +46,13 @@ const sidebar: SidebarsConfig = { label: 'Explain the search execution plan', className: 'api-method post', }, + { + type: 'doc', + id: 'version-4.X/reference/api/search-history-events-and-provide-the-number-of-events-over-time', + label: + 'Search history events and provide the number of events over time.', + className: 'api-method post', + }, { type: 'doc', id: 'version-4.X/reference/api/search-all-history-events-and-return-them',