From 48a516cd32adaccc469045df68a5f63f162d9628 Mon Sep 17 00:00:00 2001 From: Filip Hlavac <50696716+fhlavac@users.noreply.github.com> Date: Wed, 4 Dec 2024 17:23:04 +0100 Subject: [PATCH] Add compliance v2 (#430) --- packages/common/config/apis.ts | 27 +- .../content.json | 0 .../hcc-insights/compliance_v2/content.json | 17423 ++++++++++++++++ .../hcc-insights/integrations/content.json | 38 +- .../hcc-insights/notifications/content.json | 113 +- packages/discovery/Discovery.yml | 16 +- 6 files changed, 17507 insertions(+), 110 deletions(-) rename packages/common/config/apis/hcc-insights/{compliance => compliance_v1}/content.json (100%) create mode 100644 packages/common/config/apis/hcc-insights/compliance_v2/content.json diff --git a/packages/common/config/apis.ts b/packages/common/config/apis.ts index 80f93814..32ac6f46 100644 --- a/packages/common/config/apis.ts +++ b/packages/common/config/apis.ts @@ -203,16 +203,35 @@ export const apiConfigurations: ReadonlyArray> = [ tags: [apiLabelsMap["ansible"], apiLabelsMap["automation"]], }, { - id: "compliance", - displayName: "Compliance", + id: "compliance_v1", + displayName: "Compliance V1", description: "Assess, monitor, and report on the security-policy compliance of RHEL systems", icon: "InsightsIcon", - apiContentPath: "./apis/hcc-insights/compliance/content.json", + apiContentPath: "./apis/hcc-insights/compliance_v1/content.json", serverUrl: "https://console.redhat.com", getApiContent: () => import( - "./apis/hcc-insights/compliance/content.json" + "./apis/hcc-insights/compliance_v1/content.json" + ) as unknown as Promise, + tags: [ + apiLabelsMap["insights"], + apiLabelsMap["observe"], + apiLabelsMap["rhel"], + apiLabelsMap["security"], + ], + }, + { + id: "compliance_v2", + displayName: "Compliance V2", + description: + "Assess, monitor, and report on the security-policy compliance of RHEL systems", + icon: "InsightsIcon", + apiContentPath: "./apis/hcc-insights/compliance_v2/content.json", + serverUrl: "https://console.redhat.com", + getApiContent: () => + import( + "./apis/hcc-insights/compliance_v2/content.json" ) as unknown as Promise, tags: [ apiLabelsMap["insights"], diff --git a/packages/common/config/apis/hcc-insights/compliance/content.json b/packages/common/config/apis/hcc-insights/compliance_v1/content.json similarity index 100% rename from packages/common/config/apis/hcc-insights/compliance/content.json rename to packages/common/config/apis/hcc-insights/compliance_v1/content.json diff --git a/packages/common/config/apis/hcc-insights/compliance_v2/content.json b/packages/common/config/apis/hcc-insights/compliance_v2/content.json new file mode 100644 index 00000000..94b4860c --- /dev/null +++ b/packages/common/config/apis/hcc-insights/compliance_v2/content.json @@ -0,0 +1,17423 @@ +{ + "extras": {}, + "openapi": { + "components": { + "schemas": { + "errors": { + "properties": { + "errors": { + "items": { + "examples": [ + "V2::SecurityGuide not found with ID a4708198-9d00-4035-bf57-1e7aaad217c5" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "links": { + "properties": { + "first": { + "description": "Link to first page", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "last": { + "description": "Link to last page", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "next": { + "description": "Link to next page", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "previous": { + "description": "Link to previous page", + "format": "uri", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "properties": { + "filter": { + "default": "", + "description": "Query string used to filter items by their attributes", + "examples": [ + "title='Standard System Security Profile for Fedora'" + ], + "type": "string" + }, + "limit": { + "default": 10, + "description": "Number of items returned per page", + "examples": [ + 10, + 100 + ], + "maximum": 100, + "minimum": 1, + "readOnly": true, + "type": "number" + }, + "offset": { + "default": 0, + "description": "Offset of the first item of paginated response", + "examples": [ + 15, + 90 + ], + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "sort_by": { + "description": "Attribute and direction the items are sorted by", + "examples": [ + "version:asc" + ], + "type": "string" + }, + "total": { + "description": "Total number of items", + "examples": [ + 1, + 42, + 770 + ], + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "policy": { + "properties": { + "business_objective": { + "description": "The Business Objective associated to the Policy", + "examples": [ + "Guide to the Secure Configuration of Red Hat Enterprise Linux 7" + ], + "type": "string" + }, + "compliance_threshold": { + "description": "The percentage above which the Policy meets compliance requirements", + "examples": [ + 90 + ], + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "description": { + "description": "Longer description of the Policy", + "examples": [ + "This profile defines a baseline that aligns to the Center for Internet Security®Red Hat Enterprise Linux 7 Benchmark™, v2.2.0, released 12-27-2017." + ], + "type": "string" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "os_major_version": { + "description": "Major version of the Operating System that the Policy covers", + "examples": [ + 7 + ], + "minimum": 6, + "readOnly": true, + "type": "number" + }, + "profile_id": { + "description": "Identifier of the underlying Profile", + "examples": [ + "9c4bccad-eb1f-473f-bd3d-2de6e125f725" + ], + "format": "uuid", + "type": "string", + "writeOnly": true + }, + "profile_title": { + "description": "Title of the associated Policy", + "examples": [ + "CIS Red Hat Enterprise Linux 7 Benchmark" + ], + "readOnly": true, + "type": "string" + }, + "ref_id": { + "description": "Identificator of the Profile", + "examples": [ + "xccdf_org.ssgproject.content_profile_pci-dss" + ], + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Short title of the Policy", + "examples": [ + "CIS Red Hat Enterprise Linux 7 Benchmark" + ], + "type": "string" + }, + "total_system_count": { + "description": "The number of Systems assigned to this Policy", + "examples": [ + 3 + ], + "minium": 0, + "readOnly": true, + "type": "number" + }, + "type": { + "enum": [ + "policy" + ], + "readOnly": true, + "type": "string" + } + }, + "required": [ + "compliance_threshold", + "profile_id" + ], + "type": "object" + }, + "policy_update": { + "properties": { + "business_objective": { + "description": "The Business Objective associated to the Policy", + "examples": [ + "Guide to the Secure Configuration of Red Hat Enterprise Linux 7" + ], + "type": "string" + }, + "compliance_threshold": { + "description": "The percentage above which the Policy meets compliance requirements", + "examples": [ + 90 + ], + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "description": { + "description": "Longer description of the Policy", + "examples": [ + "This profile defines a baseline that aligns to the Center for Internet Security®Red Hat Enterprise Linux 7 Benchmark™, v2.2.0, released 12-27-2017." + ], + "type": "string" + } + }, + "type": "object" + }, + "profile": { + "properties": { + "description": { + "description": "Longer description of the Profile", + "examples": [ + "This profile defines a baseline that aligns to the Center for Internet Security®Red Hat Enterprise Linux 7 Benchmark™, v2.2.0, released 12-27-2017." + ], + "readOnly": true, + "type": "string" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "ref_id": { + "description": "Identificator of the Profile", + "examples": [ + "xccdf_org.ssgproject.content_profile_pci-dss" + ], + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Short title of the Profile", + "examples": [ + "CIS Red Hat Enterprise Linux 7 Benchmark" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "enum": [ + "profile" + ], + "readOnly": true, + "type": "string" + }, + "value_overrides": { + "description": "Pair of keys and values for Value Definition customizations", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "report": { + "properties": { + "all_systems_exposed": { + "description": "Informs if the user has access to all the Systems under the Report. \\\n Inconsistent under the Systems endpoint.", + "examples": [ + false + ], + "readOnly": true, + "type": "boolean" + }, + "assigned_system_count": { + "description": "The number of Systems assigned to this Report. Not visible under the Systems endpoint.", + "examples": [ + 42 + ], + "minium": 1, + "readOnly": true, + "type": "number" + }, + "business_objective": { + "description": "The Business Objective associated to the Policy", + "examples": [ + "Guide to the Secure Configuration of Red Hat Enterprise Linux 7" + ], + "readOnly": true, + "type": "string" + }, + "compliance_threshold": { + "description": "The percentage above which the Policy meets compliance requirements", + "examples": [ + 90 + ], + "maximum": 100, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "compliant_system_count": { + "description": "The number of compliant Systems in this Report. Inconsistent under the Systems endpoint.", + "examples": [ + 21 + ], + "minium": 0, + "readOnly": true, + "type": "number" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "os_major_version": { + "description": "Major version of the Operating System that the Report covers", + "examples": [ + 7 + ], + "minimum": 6, + "readOnly": true, + "type": "number" + }, + "percent_compliant": { + "description": "Describes percentage of compliant systems", + "examples": [ + 68 + ], + "maximum": 100, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "profile_title": { + "description": "Title of the associated Profile", + "examples": [ + "CIS Red Hat Enterprise Linux 7 Benchmark" + ], + "readOnly": true, + "type": "string" + }, + "ref_id": { + "description": "Identificator of the Profile", + "examples": [ + "xccdf_org.ssgproject.content_profile_pci-dss" + ], + "readOnly": true, + "type": "string" + }, + "reported_system_count": { + "description": "The number of Systems in this Report that have Test Results available. \\\n Inconsistent under the Systems endpoint.", + "examples": [ + 3 + ], + "minium": 0, + "readOnly": true, + "type": "number" + }, + "title": { + "description": "Short title of the Report", + "examples": [ + "CIS Red Hat Enterprise Linux 7 Benchmark" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "enum": [ + "report" + ], + "readOnly": true, + "type": "string" + }, + "unsupported_system_count": { + "description": "The number of unsupported Systems in this Report. \\\n Inconsistent under the Systems endpoint.", + "examples": [ + 3 + ], + "minium": 0, + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "report_stats": { + "items": { + "properties": { + "count": { + "description": "Number of failures", + "examples": [ + 102 + ], + "readOnly": true, + "type": "integer" + }, + "identifier": { + "description": "Identifier of the Rule", + "examples": [ + "CEE-1234-123" + ], + "properties": { + "label": { + "examples": [ + "CCE-80798-2" + ], + "readOnly": true, + "type": "string" + }, + "system": { + "examples": [ + "https://nvd.nist.gov/cce/index.cfm" + ], + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "ref_id": { + "description": "Identificator of the Rule", + "examples": [ + "xccdf_org.ssgproject.content_rule_package_tftp_removed" + ], + "readOnly": true, + "type": "string" + }, + "severity": { + "description": "The severity of the Rule", + "examples": [ + "low" + ], + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Short title of the Rule", + "examples": [ + "Remove tftp" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "rule": { + "properties": { + "description": { + "description": "Longer description of the Rule", + "examples": [ + "Trivial File Transfer Protocol (TFTP) is a simple file transfer protocol, typically used to automatically transfer configuration or boot files between machines. TFTP does not support authentication and can be easily hacked. The package tftp is a client program that allows for connections to a tftp server." + ], + "readOnly": true, + "type": "string" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "identifier": { + "description": "Identifier of the Rule", + "examples": [ + "CEE-1234-123" + ], + "properties": { + "label": { + "examples": [ + "CCE-80798-2" + ], + "readOnly": true, + "type": "string" + }, + "system": { + "examples": [ + "https://nvd.nist.gov/cce/index.cfm" + ], + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "precedence": { + "description": "The original sorting precedence of the Rule in the Security Guide", + "examples": [ + 3 + ], + "readOnly": true, + "type": "integer" + }, + "rationale": { + "description": "Rationale of the Rule", + "examples": [ + "It is recommended that TFTP be remvoed, unless there is a specific need for TFTP (such as a boot server). In that case, use extreme caution when configuring the services." + ], + "readOnly": true, + "type": "string" + }, + "ref_id": { + "description": "Identificator of the Rule", + "examples": [ + "xccdf_org.ssgproject.content_rule_package_tftp_removed" + ], + "readOnly": true, + "type": "string" + }, + "references": { + "description": "Array of the Rule References", + "items": { + "description": "List of Tags assigned to the System", + "properties": { + "href": { + "examples": [ + "https://www.isaca.org/resources/cobit" + ], + "readOnly": true, + "type": "string" + }, + "label": { + "examples": [ + "APO01.06" + ], + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "remediation_available": { + "description": "Whether or not a remediation is available for the given rule.", + "examples": [ + true, + false + ], + "readOnly": true, + "type": "boolean" + }, + "remediation_issue_id": { + "description": "The idenfitier of the remediation associated to this rule, only available under profiles.", + "examples": [ + "ssg:rhel6|rht-ccp|xccdf_org.ssgproject.content_rule_sshd_disable_rhosts" + ], + "readOnly": true, + "type": [ + "string", + "null" + ] + }, + "rule_group_id": { + "description": "UUID of the parent Rule Group", + "examples": [ + "cf50fd69-0205-49e8-8e12-c1b2a6291f1d" + ], + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "severity": { + "description": "The severity of the Rule", + "examples": [ + "low" + ], + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Short title of the Rule", + "examples": [ + "Remove tftp" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "enum": [ + "rule" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "rule_group": { + "properties": { + "description": { + "description": "Longer description of the Rule Group", + "examples": [ + "The pam_faillock PAM module provides the capability to lock out user accounts after a number of failed login attempts. Its documentation is available in /usr/share/doc/pam-VERSION/txts/README.pam_faillock." + ], + "readOnly": true, + "type": "string" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "precedence": { + "description": "The original sorting precedence of the Rule Group in the Security Guide", + "examples": [ + 3 + ], + "readOnly": true, + "type": "integer" + }, + "rationale": { + "description": "Rationale of the Rule Group", + "examples": [ + "By limiting the number of failed logon attempts, the risk of unauthorized system access via user password guessing, otherwise known as brute-forcing, is reduced. Limits are imposed by locking the account." + ], + "readOnly": true, + "type": "string" + }, + "ref_id": { + "description": "Identificator of the Rule Group", + "examples": [ + "xccdf_org.ssgproject.content_group_locking_out_password_attempts" + ], + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Short title of the Rule Group", + "examples": [ + "Set Lockouts for Failed Password Attempt" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "enum": [ + "rule_group" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "rule_result": { + "properties": { + "description": { + "description": "Longer description of the Rule", + "examples": [ + "Trivial File Transfer Protocol (TFTP) is a simple file transfer protocol, typically used to automatically transfer configuration or boot files between machines. TFTP does not support authentication and can be easily hacked. The package tftp is a client program that allows for connections to a tftp server." + ], + "readOnly": true, + "type": "string" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "precedence": { + "description": "The original sorting precedence of the Rule in the Security Guide", + "examples": [ + 3 + ], + "readOnly": true, + "type": "integer" + }, + "rationale": { + "description": "Rationale of the Rule", + "examples": [ + "It is recommended that TFTP be remvoed, unless there is a specific need for TFTP (such as a boot server). In that case, use extreme caution when configuring the services." + ], + "readOnly": true, + "type": "string" + }, + "ref_id": { + "description": "Identificator of the Rule", + "examples": [ + "xccdf_org.ssgproject.content_rule_package_tftp_removed" + ], + "readOnly": true, + "type": "string" + }, + "remediation_issue_id": { + "description": "The idenfitier of the remediation associated to this rule, only available under profiles.", + "examples": [ + "ssg:rhel6|rht-ccp|xccdf_org.ssgproject.content_rule_sshd_disable_rhosts" + ], + "readOnly": true, + "type": [ + "string", + "null" + ] + }, + "result": { + "description": "Status of the Rule Result", + "enum": [ + "pass", + "fail", + "error", + "unknown", + "fixed", + "notapplicable", + "notchecked", + "informational", + "notselected" + ], + "readOnly": true, + "type": "string" + }, + "rule_group_id": { + "description": "UUID of the parent Rule Group", + "examples": [ + "cf50fd69-0205-49e8-8e12-c1b2a6291f1d" + ], + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "rule_id": { + "description": "UUID of the affected Rule", + "examples": [ + "ac0475d7-043c-439b-abef-606f02531e10" + ], + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "severity": { + "description": "The severity of the Rule", + "examples": [ + "low" + ], + "readOnly": true, + "type": "string" + }, + "system_id": { + "description": "UUID of the affected System", + "examples": [ + "e6ba5c79-48af-4899-bb1d-964116b58c7a" + ], + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Short title of the Rule", + "examples": [ + "Remove tftp" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "enum": [ + "rule" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "rule_tree": { + "items": { + "oneOf": [ + { + "properties": { + "children": { + "$ref": "#/components/schemas/rule_tree" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "type": { + "enum": [ + "rule_group" + ], + "type": "string" + } + }, + "type": "object" + }, + { + "properties": { + "id": { + "$ref": "#/components/schemas/id" + }, + "type": { + "enum": [ + "rule" + ], + "type": "string" + } + }, + "type": "object" + } + ] + }, + "type": "array" + }, + "security_guide": { + "properties": { + "description": { + "description": "Longer description of the Security Guide", + "examples": [ + "This guide presents a catalog of security-relevant configuration settings for Red Hat Enterprise Linux 7." + ], + "readOnly": true, + "type": "string" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "os_major_version": { + "description": "Major version of the Operating System that the Security Guide covers", + "examples": [ + 7 + ], + "minimum": 6, + "readOnly": true, + "type": "number" + }, + "ref_id": { + "description": "Identificator of the Security Guide", + "examples": [ + "xccdf_org.ssgproject.content_benchmark_RHEL-7" + ], + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Short title of the Security Guide", + "examples": [ + "Guide to the Secure Configuration of Red Hat Enterprise Linux 7" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "enum": [ + "security_guide" + ], + "readOnly": true, + "type": "string" + }, + "version": { + "description": "Version of the Security Guide", + "examples": [ + "0.1.46" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "supported_profile": { + "properties": { + "description": { + "description": "Longer description of the Profile", + "examples": [ + "This profile defines a baseline that aligns to the Center for Internet Security®Red Hat Enterprise Linux 7 Benchmark™, v2.2.0, released 12-27-2017." + ], + "readOnly": true, + "type": "string" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "os_major_version": { + "description": "Major version of the Operating System that the Profile covers", + "examples": [ + 7 + ], + "readOnly": true, + "type": "number" + }, + "os_minor_versions": { + "description": "List of the supported Operating System minor versions that the Profile covers", + "items": { + "examples": [ + 1 + ], + "type": "number" + }, + "readOnly": true, + "type": "array" + }, + "ref_id": { + "description": "Identificator of the latest supported Profile", + "examples": [ + "xccdf_org.ssgproject.content_profile_cis" + ], + "readOnly": true, + "type": "string" + }, + "security_guide_id": { + "description": "UUID of the latest Security Guide supporting this Profile", + "examples": [ + "e6ba5c79-48af-4899-bb1d-964116b58c7a" + ], + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "security_guide_version": { + "description": "Version of the latest Security Guide supporting this Profile", + "examples": [ + "0.1.72" + ], + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Short title of the Profile", + "examples": [ + "CIS Red Hat Enterprise Linux 7 Benchmark" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "enum": [ + "supported_profile" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "system": { + "properties": { + "culled_timestamp": { + "examples": [ + "2020-06-04T19:31:55Z" + ], + "readOnly": true, + "type": "string" + }, + "display_name": { + "description": "Display Name of the System", + "examples": [ + "localhost" + ], + "readOnly": true, + "type": "string" + }, + "groups": { + "items": { + "description": "List of Inventory Groups the System belongs to", + "properties": { + "id": { + "$ref": "#/components/schemas/id" + }, + "name": { + "examples": [ + "production" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "insights_id": { + "$ref": "#/components/schemas/id" + }, + "os_major_version": { + "description": "Major version of the Operating System", + "examples": [ + 7 + ], + "readOnly": true, + "type": "number" + }, + "os_minor_version": { + "description": "Minor version of the Operating System", + "examples": [ + 1 + ], + "readOnly": true, + "type": "number" + }, + "policies": { + "description": "List of Policies assigned to the System, visible only when not listing Systems under a given Policy", + "items": { + "properties": { + "id": { + "$ref": "#/components/schemas/id" + }, + "title": { + "description": "Short title of the Policy", + "examples": [ + "CIS Red Hat Enterprise Linux 7 Benchmark" + ], + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "stale_timestamp": { + "examples": [ + "2020-06-04T19:31:55Z" + ], + "readOnly": true, + "type": "string" + }, + "stale_warning_timestamp": { + "examples": [ + "2020-06-04T19:31:55Z" + ], + "readOnly": true, + "type": "string" + }, + "tags": { + "items": { + "description": "List of Tags assigned to the System", + "properties": { + "key": { + "examples": [ + "environment" + ], + "readOnly": true, + "type": "string" + }, + "namespace": { + "examples": [ + "insights" + ], + "readOnly": true, + "type": "string" + }, + "value": { + "examples": [ + "production" + ], + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "type": { + "enum": [ + "system" + ], + "readOnly": true, + "type": "string" + }, + "updated": { + "examples": [ + "2020-06-04T19:31:55Z" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "tailoring": { + "properties": { + "id": { + "$ref": "#/components/schemas/id" + }, + "os_major_version": { + "description": "Major version of the Operating System that the Tailoring covers", + "examples": [ + 7 + ], + "readOnly": true, + "type": "number" + }, + "os_minor_version": { + "description": "Minor version of the Operating System that the Tailoring covers", + "examples": [ + 1 + ], + "readOnly": true, + "type": "number" + }, + "profile_id": { + "description": "Identificator of the Profile from which the Tailoring was cloned", + "examples": [ + "cde8be06-74bc-4a2d-9e7f-11d30c5ea588" + ], + "readOnly": true, + "type": "string" + }, + "security_guide_id": { + "description": "Identificator of the Security Guide that contains the parent Profile", + "examples": [ + "8800e1d8-70da-4e62-8cf0-16e8cee784c7" + ], + "readOnly": true, + "type": "string" + }, + "security_guide_version": { + "description": "Version of the Security Guide that contains the parent Profile", + "examples": [ + "0.1.210" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "enum": [ + "tailoring" + ], + "readOnly": true, + "type": "string" + }, + "value_overrides": { + "description": "Pair of keys and values for Value Definition customizations", + "examples": [ + { + "5755ab37-cbbd-453b-a0d8-cb3dd50110ee": "false", + "5d249a75-52b5-46b5-8c63-48584e8fb287": "foo", + "76e7a222-d6a1-415e-ae2d-8a412d844d9a": "123" + } + ], + "type": "object" + } + }, + "type": "object" + }, + "tailoring_create": { + "properties": { + "os_minor_version": { + "description": "Minor version of the Operating System that the Tailoring covers", + "examples": [ + 1 + ], + "type": "number" + } + }, + "required": [ + "os_minor_version" + ], + "type": "object" + }, + "tailoring_file": { + "additionalProperties": true, + "description": "Defines customizations of rules and variables for a set of profiles", + "properties": { + "profiles": { + "items": { + "additionalProperties": true, + "anyOf": [ + { + "required": [ + "id", + "base_profile_id" + ] + }, + { + "required": [ + "id", + "title" + ] + } + ], + "description": "A new tailored profile with modifications", + "properties": { + "base_profile_id": { + "description": "Original profile identifier, the base for modifications", + "type": "string" + }, + "groups": { + "additionalProperties": { + "additionalProperties": true, + "anyOf": [ + { + "required": [ + "evaluate" + ] + } + ], + "properties": { + "evaluate": { + "description": "Includes or excludes a group of rules from evaluation", + "type": "boolean" + } + }, + "type": "object" + }, + "description": "Group modifications, keys are identifiers", + "type": "object" + }, + "id": { + "description": "New profile identifier, can be same as 'base_profile_id', to 'shadow' the origin", + "type": "string" + }, + "rules": { + "additionalProperties": { + "additionalProperties": true, + "anyOf": [ + { + "required": [ + "evaluate" + ] + }, + { + "required": [ + "severity" + ] + }, + { + "required": [ + "role" + ] + } + ], + "properties": { + "evaluate": { + "description": "Includes or excludes a rule from evaluation", + "type": "boolean" + }, + "role": { + "description": "Overrides role of the rule", + "enum": [ + "full", + "unscored", + "unchecked" + ], + "type": "string" + }, + "severity": { + "description": "Overrides severity level of the rule", + "enum": [ + "unknown", + "info", + "low", + "medium", + "high" + ], + "type": "string" + } + }, + "type": "object" + }, + "description": "Rule modifications, keys are identifiers", + "type": "object" + }, + "title": { + "description": "Title for the new profile, inherited from base profile if not given, required if there is no base profile", + "type": "string" + }, + "variables": { + "additionalProperties": { + "additionalProperties": true, + "oneOf": [ + { + "required": [ + "value" + ] + }, + { + "required": [ + "option_id" + ] + } + ], + "properties": { + "option_id": { + "description": "Overrides variable's value with a predefined value identified by 'option_id'", + "type": "string" + }, + "value": { + "description": "Directly overrides variable's value with a given value", + "type": [ + "string", + "integer", + "boolean" + ] + } + }, + "type": "object" + }, + "description": "Variables modifications, keys are identifiers", + "type": "object" + } + }, + "title": "Profile", + "type": "object" + }, + "type": "array" + } + }, + "title": "Tailoring File", + "type": "object" + }, + "test_result": { + "properties": { + "compliant": { + "description": "Whether the Test Result is compliant or not within a given Report.", + "examples": [ + false, + true + ], + "readOnly": true, + "type": [ + "boolean", + "null" + ] + }, + "display_name": { + "description": "Display Name of the System", + "examples": [ + "localhost" + ], + "readOnly": true, + "type": "string" + }, + "end_time": { + "description": "The date when the System has been reported a Test Result for the last time.", + "examples": [ + "2020-06-04T19:31:55Z" + ], + "readOnly": true, + "type": "string" + }, + "failed_rule_count": { + "description": "Number of failed rules in the Test Result", + "examples": [ + 3 + ], + "readOnly": true, + "type": [ + "integer", + "null" + ] + }, + "groups": { + "items": { + "description": "List of Inventory Groups the System belongs to", + "properties": { + "id": { + "$ref": "#/components/schemas/id" + }, + "name": { + "examples": [ + "production" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "os_major_version": { + "description": "Major version of the Operating System", + "examples": [ + 7 + ], + "readOnly": true, + "type": "number" + }, + "os_minor_version": { + "description": "Minor version of the Operating System", + "examples": [ + 1 + ], + "readOnly": true, + "type": "number" + }, + "score": { + "description": "Compliance Score of the System within a given Report.", + "examples": [ + 99.99 + ], + "readOnly": true, + "type": "number" + }, + "supported": { + "description": "Whether the System is supported or not by a Profile within a given Policy.", + "examples": [ + false, + true + ], + "readOnly": true, + "type": [ + "boolean", + "null" + ] + }, + "system_id": { + "description": "UUID of the underlying System", + "examples": [ + "e6ba5c79-48af-4899-bb1d-964116b58c7a" + ], + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "tags": { + "items": { + "description": "List of Tags assigned to the System", + "properties": { + "key": { + "examples": [ + "environment" + ], + "readOnly": true, + "type": "string" + }, + "namespace": { + "examples": [ + "insights" + ], + "readOnly": true, + "type": "string" + }, + "value": { + "examples": [ + "production" + ], + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "type": { + "enum": [ + "test_result" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "value_definition": { + "properties": { + "default_value": { + "description": "Default value of the Value Definition", + "examples": [ + "512M" + ], + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Longer description of the Value Definition", + "examples": [ + "Specify the size component of the rekey limit." + ], + "readOnly": true, + "type": "string" + }, + "id": { + "$ref": "#/components/schemas/id" + }, + "ref_id": { + "description": "Identificator of the Value Definition", + "examples": [ + "xccdf_org.ssgproject.content_value_var_rekey_limit_size" + ], + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Short title of the Value Definition", + "examples": [ + "SSH RekeyLimit - size" + ], + "readOnly": true, + "type": "string" + }, + "type": { + "enum": [ + "value_definition" + ], + "type": "string" + }, + "value_type": { + "description": "Type of the Value Definition", + "examples": [ + "string" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + } + }, + "info": { + "description": "This is the API for Cloud Services for RHEL Compliance. You can find out more about Red Hat Cloud Services for RHEL at [https://console.redhat.com/](https://console.redhat.com/)", + "title": "Cloud Services for RHEL Compliance API V2", + "version": "v2" + }, + "openapi": "3.1.0", + "paths": { + "/policies": { + "get": { + "description": "Retrieve the list of policies that have been created to test the compliance of your registered systems.", + "operationId": "Policies", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "os_major_version", + "total_system_count", + "business_objective", + "compliance_threshold", + "title:asc", + "title:desc", + "os_major_version:asc", + "os_major_version:desc", + "total_system_count:asc", + "total_system_count:desc", + "business_objective:asc", + "business_objective:desc", + "compliance_threshold:asc", + "compliance_threshold:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Policies are searchable using attributes `title`, `os_major_version`, and `os_minor_version`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Policies": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "business_objective": null, + "compliance_threshold": 47, + "description": "Et eos blanditiis. Repellat ullam error. Provident qui quos.", + "id": "0926253f-f9f5-453e-8b80-ae0a38515cc7", + "os_major_version": 7, + "profile_title": "Repellat rerum magnam qui.", + "ref_id": "xccdf_org.ssgproject.content_profile_d7cf760b9eecd58c74751603393fc2f4", + "title": "Vero assumenda error quo.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 21, + "description": "Dicta nesciunt aut. Cumque magni excepturi. Necessitatibus ad omnis.", + "id": "0e6963b8-8af0-4fdc-a2fc-bff28bd2ef09", + "os_major_version": 7, + "profile_title": "Cumque sed iure vitae.", + "ref_id": "xccdf_org.ssgproject.content_profile_05cb43b11b8826002a297a7ab5531633", + "title": "Alias omnis dignissimos vel.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 76, + "description": "Consequuntur velit et. Consectetur fugit in. Est non at.", + "id": "15ca7ac6-f2bb-4d35-af77-1ceedb16af3b", + "os_major_version": 7, + "profile_title": "Quibusdam eveniet sit ut.", + "ref_id": "xccdf_org.ssgproject.content_profile_78790567c2aa85950858b6c8bad3079c", + "title": "A doloribus dolor modi.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 34, + "description": "Eveniet aut culpa. Architecto facilis quidem. Voluptatem et sunt.", + "id": "1f9bd602-b0de-47f2-83f7-db5a6ccc3ff1", + "os_major_version": 7, + "profile_title": "Velit qui velit id.", + "ref_id": "xccdf_org.ssgproject.content_profile_974e689ef1b4e08aaa958cb8f1009254", + "title": "Accusamus adipisci debitis sint.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 79, + "description": "Laboriosam natus magnam. Non sit maxime. Rerum voluptatem iure.", + "id": "249ab3d7-d2d8-4cca-9a94-277cb3fdb612", + "os_major_version": 7, + "profile_title": "Nostrum praesentium et nobis.", + "ref_id": "xccdf_org.ssgproject.content_profile_72d708b1a4c7902bfd67641dbbf76776", + "title": "Quia ut occaecati accusantium.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 79, + "description": "Ullam nam facere. Itaque aut et. Voluptatem eius repellat.", + "id": "2744c447-111b-42ad-96e5-85e0590a5a32", + "os_major_version": 7, + "profile_title": "Alias suscipit pariatur distinctio.", + "ref_id": "xccdf_org.ssgproject.content_profile_064b40ccf9aeac311a2738e3a7fc4155", + "title": "Enim ducimus est voluptas.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 98, + "description": "Aperiam molestiae aut. Libero et consectetur. Vitae commodi blanditiis.", + "id": "2e0933d6-969c-457a-9726-0f58367ad6b2", + "os_major_version": 7, + "profile_title": "Ut voluptatem aut eligendi.", + "ref_id": "xccdf_org.ssgproject.content_profile_009193b5c204ef63d30c1fbe54ffa672", + "title": "Deserunt dolores quos ipsum.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 69, + "description": "Porro voluptates laudantium. Aut molestiae vel. Expedita sit esse.", + "id": "3c02beca-de17-4e41-ac1e-ca4438869507", + "os_major_version": 7, + "profile_title": "Aliquam rem quae tempora.", + "ref_id": "xccdf_org.ssgproject.content_profile_d5ae0d259bb58156ff07332e8bfd6910", + "title": "Possimus nulla necessitatibus facilis.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 85, + "description": "Minus enim consectetur. Libero adipisci illum. Velit ipsa eos.", + "id": "405d017d-ef8a-4ae5-beeb-952cc17840fd", + "os_major_version": 7, + "profile_title": "Nostrum sed ut non.", + "ref_id": "xccdf_org.ssgproject.content_profile_be30c6268a013b7f97644451678f19c0", + "title": "Non est aliquid consectetur.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 42, + "description": "Est excepturi fuga. Adipisci iure officia. Ratione quisquam in.", + "id": "42303347-a068-4f71-aa08-d9f56ad606aa", + "os_major_version": 7, + "profile_title": "Non in doloribus perspiciatis.", + "ref_id": "xccdf_org.ssgproject.content_profile_1b3527aaf143412deaa2b5d23f61f4cc", + "title": "Fugit sit reprehenderit dolor.", + "total_system_count": 0, + "type": "policy" + } + ], + "links": { + "first": "/api/compliance/v2/policies?limit=10&offset=0", + "last": "/api/compliance/v2/policies?limit=10&offset=20", + "next": "/api/compliance/v2/policies?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + }, + "List of Policies filtered by \"(os_major_version=8)\"": { + "description": "", + "summary": "", + "value": { + "data": [], + "links": { + "first": "/api/compliance/v2/policies?filter=%28os_major_version%3D8%29&limit=10&offset=0", + "last": "/api/compliance/v2/policies?filter=%28os_major_version%3D8%29&limit=10&offset=0" + }, + "meta": { + "filter": "(os_major_version=8)", + "limit": 10, + "offset": 0, + "total": 0 + } + } + }, + "List of Policies sorted by \"os_major_version:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "business_objective": null, + "compliance_threshold": 31, + "description": "Perferendis sit sint. Magnam libero et. Aut cumque et.", + "id": "07a7672c-7781-4f75-80f9-fbe943beb1e3", + "os_major_version": 7, + "profile_title": "Ea quos ipsa molestias.", + "ref_id": "xccdf_org.ssgproject.content_profile_859f90f1aee25718d7c7d21b7ac7b072", + "title": "Nihil voluptate sint vel.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 93, + "description": "Harum dolor quia. Praesentium fugit non. Nihil pariatur molestiae.", + "id": "10ce2785-9da4-41f9-af03-e12417ad53ed", + "os_major_version": 7, + "profile_title": "Fuga ut atque sit.", + "ref_id": "xccdf_org.ssgproject.content_profile_a9ab1b5105ae2d62c66363d6d9f42c42", + "title": "Nesciunt impedit recusandae sapiente.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 15, + "description": "Vero eos dolores. Dolore eos aut. Est aut et.", + "id": "12cfe39d-de71-446f-b480-ad4de580ba22", + "os_major_version": 7, + "profile_title": "A reprehenderit consequatur omnis.", + "ref_id": "xccdf_org.ssgproject.content_profile_c1c6ce49152b8fc0990bb1ff9bba4755", + "title": "Et omnis magni necessitatibus.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 17, + "description": "Iusto illo doloremque. Quibusdam libero et. Qui aut et.", + "id": "28e1f990-a103-4200-91ca-18b901fb2bdb", + "os_major_version": 7, + "profile_title": "Sit eius repellat architecto.", + "ref_id": "xccdf_org.ssgproject.content_profile_8e051b0dccbaae93a56e82d3c3c475fb", + "title": "Dignissimos consectetur amet est.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 14, + "description": "Suscipit inventore vel. Illo maiores iure. Ipsum natus omnis.", + "id": "2a6db940-67b9-42d7-a5cf-f7502cd2d322", + "os_major_version": 7, + "profile_title": "Ipsa dolore et nemo.", + "ref_id": "xccdf_org.ssgproject.content_profile_3bb4b3c9f5ece311a9dde17f828be6d3", + "title": "Alias eos quod vel.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 29, + "description": "Ipsa distinctio doloremque. Eaque labore iste. Modi necessitatibus aliquam.", + "id": "2a7cf41c-4c63-49f2-97f6-88cb25b71579", + "os_major_version": 7, + "profile_title": "Consequuntur est distinctio rerum.", + "ref_id": "xccdf_org.ssgproject.content_profile_6f320a46ea8322231752a6eecc1a3c0d", + "title": "Quo vero qui deleniti.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 3, + "description": "Numquam necessitatibus excepturi. Quos voluptatem suscipit. Minima eius quia.", + "id": "30b513de-fe85-48b5-b536-ae370fa9a87b", + "os_major_version": 7, + "profile_title": "Qui perferendis fugit autem.", + "ref_id": "xccdf_org.ssgproject.content_profile_ec563cd0af91d2d868831468f5984e6c", + "title": "Tempora omnis reiciendis qui.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 26, + "description": "Quas modi qui. Velit sed aut. Fugit cupiditate earum.", + "id": "3722b949-669e-42a6-bbb3-3d6ba592c838", + "os_major_version": 7, + "profile_title": "Ad sed est incidunt.", + "ref_id": "xccdf_org.ssgproject.content_profile_0aaf85bb7b03868a3e2e76205370e412", + "title": "Quaerat occaecati fuga inventore.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 81, + "description": "Tenetur et quo. Cum quo vitae. Et labore fugit.", + "id": "3cbd8a94-b914-4d39-92fb-ecaa5428d3bb", + "os_major_version": 7, + "profile_title": "Et voluptate ea eligendi.", + "ref_id": "xccdf_org.ssgproject.content_profile_bddb249fcdc5ed74d02ef1c14e4534f2", + "title": "Quia minima veritatis et.", + "total_system_count": 0, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 36, + "description": "Provident ad et. Aspernatur distinctio consequatur. Est natus facere.", + "id": "4492f30a-3c90-43cf-a0b5-a0cdbb3b6e46", + "os_major_version": 7, + "profile_title": "Sed assumenda sint cumque.", + "ref_id": "xccdf_org.ssgproject.content_profile_7ff3f5388b64988a9b77864593c22e15", + "title": "Eveniet aut sit est.", + "total_system_count": 0, + "type": "policy" + } + ], + "links": { + "first": "/api/compliance/v2/policies?limit=10&offset=0&sort_by=os_major_version", + "last": "/api/compliance/v2/policies?limit=10&offset=20&sort_by=os_major_version", + "next": "/api/compliance/v2/policies?limit=10&offset=10&sort_by=os_major_version" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "os_major_version", + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/policy" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Policies" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Policies", + "tags": [ + "Policies" + ] + }, + "post": { + "description": "Create a new security policy.", + "operationId": "CreatePolicy", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/policy" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "examples": { + "Response example": { + "description": "", + "summary": "", + "value": { + "data": { + "business_objective": "Serious Business Objective", + "compliance_threshold": 33.3, + "description": "Hello World", + "id": "eeb793ec-c1c9-4263-9b5b-aecf0c12f471", + "os_major_version": 7, + "profile_title": "Voluptate nisi et aperiam.", + "ref_id": "xccdf_org.ssgproject.content_profile_a3d538d8ef6c3fb133975a8dc9aac72d", + "title": "Foo", + "total_system_count": null, + "type": "policy" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/policy" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Creates a Policy" + } + }, + "summary": "Create a Policy", + "tags": [ + "Policies" + ] + } + }, + "/policies/{policy_id}": { + "delete": { + "description": "Delete a specific policy.", + "operationId": "DeletePolicy", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "Deletes a Policy": { + "description": "", + "summary": "", + "value": { + "data": { + "business_objective": null, + "compliance_threshold": 57, + "description": "Eos asperiores illo. Qui consectetur quibusdam. Earum iste dolor.", + "id": "d7c2649d-4808-40d7-bf37-4e6c57256e56", + "os_major_version": 7, + "profile_title": "Quidem iste facere incidunt.", + "ref_id": "xccdf_org.ssgproject.content_profile_2b94b9424c04119718f6f9adfac98b8d", + "title": "Ab et corporis minus.", + "total_system_count": 0, + "type": "policy" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/policy" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Deletes a Policy" + } + }, + "summary": "Delete a Policy", + "tags": [ + "Policies" + ] + }, + "get": { + "description": "Retrieve a specific policy.", + "operationId": "Policy", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Policy": { + "description": "", + "summary": "", + "value": { + "data": { + "business_objective": null, + "compliance_threshold": 72, + "description": "Eveniet quo officiis. Non tempora praesentium. Quod recusandae qui.", + "id": "0b3954b1-2002-49f8-b061-c4a6c405f694", + "os_major_version": 7, + "profile_title": "Reiciendis nam suscipit magni.", + "ref_id": "xccdf_org.ssgproject.content_profile_25a2e6da9e549aa668ad9d541ff9e1b0", + "title": "Aut molestias officia veritatis.", + "total_system_count": 0, + "type": "policy" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/policy" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Policy" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Policy": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Policy not found with ID e712e3b7-52cb-401e-a7ad-0192806652ab" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Policy", + "tags": [ + "Policies" + ] + }, + "patch": { + "description": "Edit or update an existing policy.", + "operationId": "UpdatePolicy", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/policy_update" + } + } + } + }, + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns the updated Policy": { + "description": "", + "summary": "", + "value": { + "data": { + "business_objective": null, + "compliance_threshold": 100, + "description": "Et aut facere. Et ut temporibus. Provident harum odit.", + "id": "d93e8af4-177b-47fd-bda3-86c0da40609a", + "os_major_version": 7, + "profile_title": "Praesentium esse facere accusamus.", + "ref_id": "xccdf_org.ssgproject.content_profile_6330eb3959ac56a5ed0075e583834632", + "title": "Odio ea consequatur aliquam.", + "total_system_count": 0, + "type": "policy" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/policy" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Updates a Policy" + } + }, + "summary": "Update a Policy", + "tags": [ + "Policies" + ] + } + }, + "/policies/{policy_id}/systems": { + "get": { + "description": "Retrieve all of the systems assigned to a specific policy.", + "operationId": "PolicySystems", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "An array of tags to narrow down the search results. In case the value contains symbols used for separators (`/` or `=`), they need to be encoded.
e.g.: `namespace/key=value`, `insights-client/selinux-config=SELINUX%3Denforcing`", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "display_name", + "os_minor_version", + "os_version", + "groups", + "display_name:asc", + "display_name:desc", + "os_minor_version:asc", + "os_minor_version:desc", + "os_version:asc", + "os_version:desc", + "groups:asc", + "groups:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_minor_version`, and `group_name`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Systems": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:08.040Z", + "display_name": "olson.test", + "groups": [], + "id": "0b072e35-b24b-4e91-9923-763858c4699e", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.040Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.040Z", + "tags": [ + { + "key": "feed", + "namespace": "calculating", + "value": "online" + }, + { + "key": "pixel", + "namespace": "hacking", + "value": "open-source" + }, + { + "key": "firewall", + "namespace": "generating", + "value": "multi-byte" + }, + { + "key": "feed", + "namespace": "generating", + "value": "multi-byte" + }, + { + "key": "hard drive", + "namespace": "quantifying", + "value": "1080p" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.040Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.070Z", + "display_name": "stark.test", + "groups": [], + "id": "1451e499-3556-440c-8f98-3da37304ee1e", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.070Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.070Z", + "tags": [ + { + "key": "system", + "namespace": "synthesizing", + "value": "wireless" + }, + { + "key": "hard drive", + "namespace": "synthesizing", + "value": "online" + }, + { + "key": "microchip", + "namespace": "generating", + "value": "bluetooth" + }, + { + "key": "matrix", + "namespace": "parsing", + "value": "auxiliary" + }, + { + "key": "card", + "namespace": "bypassing", + "value": "redundant" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.070Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.997Z", + "display_name": "hintz.test", + "groups": [], + "id": "1d002b12-6098-4475-a78a-90d642d4c074", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:07.997Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.997Z", + "tags": [ + { + "key": "array", + "namespace": "connecting", + "value": "mobile" + }, + { + "key": "alarm", + "namespace": "indexing", + "value": "primary" + }, + { + "key": "transmitter", + "namespace": "synthesizing", + "value": "haptic" + }, + { + "key": "matrix", + "namespace": "quantifying", + "value": "cross-platform" + }, + { + "key": "application", + "namespace": "overriding", + "value": "back-end" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.997Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.003Z", + "display_name": "brown-yost.test", + "groups": [], + "id": "472d3259-f50b-48f1-84b1-20ed11db993e", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.003Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.003Z", + "tags": [ + { + "key": "hard drive", + "namespace": "parsing", + "value": "optical" + }, + { + "key": "program", + "namespace": "hacking", + "value": "bluetooth" + }, + { + "key": "interface", + "namespace": "calculating", + "value": "primary" + }, + { + "key": "panel", + "namespace": "copying", + "value": "auxiliary" + }, + { + "key": "transmitter", + "namespace": "generating", + "value": "redundant" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.003Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.079Z", + "display_name": "oconner.test", + "groups": [], + "id": "5fa793ba-5409-4b7a-918b-97f52f20037d", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.079Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.079Z", + "tags": [ + { + "key": "monitor", + "namespace": "programming", + "value": "bluetooth" + }, + { + "key": "circuit", + "namespace": "programming", + "value": "neural" + }, + { + "key": "feed", + "namespace": "backing up", + "value": "online" + }, + { + "key": "driver", + "namespace": "bypassing", + "value": "cross-platform" + }, + { + "key": "firewall", + "namespace": "hacking", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.080Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.018Z", + "display_name": "conn.example", + "groups": [], + "id": "6128214c-b3bc-4130-bd91-52e0a936ef9a", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.018Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.018Z", + "tags": [ + { + "key": "feed", + "namespace": "compressing", + "value": "mobile" + }, + { + "key": "card", + "namespace": "calculating", + "value": "open-source" + }, + { + "key": "bandwidth", + "namespace": "navigating", + "value": "virtual" + }, + { + "key": "program", + "namespace": "backing up", + "value": "open-source" + }, + { + "key": "feed", + "namespace": "overriding", + "value": "multi-byte" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.018Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.975Z", + "display_name": "kohler.test", + "groups": [], + "id": "66959695-b4a7-47fa-b2b9-58f3f2b9271e", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:07.975Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.975Z", + "tags": [ + { + "key": "microchip", + "namespace": "parsing", + "value": "back-end" + }, + { + "key": "sensor", + "namespace": "navigating", + "value": "haptic" + }, + { + "key": "array", + "namespace": "indexing", + "value": "online" + }, + { + "key": "driver", + "namespace": "connecting", + "value": "multi-byte" + }, + { + "key": "port", + "namespace": "calculating", + "value": "primary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.975Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.098Z", + "display_name": "wolff-skiles.test", + "groups": [], + "id": "66b8d413-ce7b-4c6a-8433-f77930fa82c7", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.098Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.098Z", + "tags": [ + { + "key": "program", + "namespace": "quantifying", + "value": "multi-byte" + }, + { + "key": "driver", + "namespace": "copying", + "value": "1080p" + }, + { + "key": "program", + "namespace": "transmitting", + "value": "online" + }, + { + "key": "array", + "namespace": "navigating", + "value": "auxiliary" + }, + { + "key": "matrix", + "namespace": "hacking", + "value": "cross-platform" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.098Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.103Z", + "display_name": "tillman.test", + "groups": [], + "id": "73617798-231a-4248-b14d-9b129e77b0c3", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.103Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.103Z", + "tags": [ + { + "key": "program", + "namespace": "calculating", + "value": "open-source" + }, + { + "key": "application", + "namespace": "calculating", + "value": "redundant" + }, + { + "key": "hard drive", + "namespace": "transmitting", + "value": "neural" + }, + { + "key": "bandwidth", + "namespace": "hacking", + "value": "wireless" + }, + { + "key": "bandwidth", + "namespace": "generating", + "value": "bluetooth" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.103Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.034Z", + "display_name": "weimann.test", + "groups": [], + "id": "75b7b206-e71d-400b-b136-0cb5c8410552", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.034Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.034Z", + "tags": [ + { + "key": "microchip", + "namespace": "bypassing", + "value": "cross-platform" + }, + { + "key": "application", + "namespace": "overriding", + "value": "haptic" + }, + { + "key": "driver", + "namespace": "transmitting", + "value": "mobile" + }, + { + "key": "circuit", + "namespace": "copying", + "value": "bluetooth" + }, + { + "key": "port", + "namespace": "copying", + "value": "back-end" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.034Z" + } + ], + "links": { + "first": "/api/compliance/v2/policies/4d57913c-ca1d-47af-9717-98f09e60d49b/systems?limit=10&offset=0", + "last": "/api/compliance/v2/policies/4d57913c-ca1d-47af-9717-98f09e60d49b/systems?limit=10&offset=20", + "next": "/api/compliance/v2/policies/4d57913c-ca1d-47af-9717-98f09e60d49b/systems?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "tags": [], + "total": 25 + } + } + }, + "List of Systems filtered by \"(os_minor_version=0)\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:08.355Z", + "display_name": "jacobs.test", + "groups": [], + "id": "073920fd-6371-476b-9d94-59d365b2bf36", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.355Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.355Z", + "tags": [ + { + "key": "circuit", + "namespace": "synthesizing", + "value": "virtual" + }, + { + "key": "capacitor", + "namespace": "connecting", + "value": "neural" + }, + { + "key": "array", + "namespace": "copying", + "value": "optical" + }, + { + "key": "port", + "namespace": "transmitting", + "value": "bluetooth" + }, + { + "key": "hard drive", + "namespace": "parsing", + "value": "digital" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.355Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.328Z", + "display_name": "kuhn.example", + "groups": [], + "id": "076877be-3449-468d-addc-73fe82453e08", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.328Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.328Z", + "tags": [ + { + "key": "sensor", + "namespace": "bypassing", + "value": "auxiliary" + }, + { + "key": "bandwidth", + "namespace": "connecting", + "value": "optical" + }, + { + "key": "matrix", + "namespace": "backing up", + "value": "bluetooth" + }, + { + "key": "port", + "namespace": "backing up", + "value": "redundant" + }, + { + "key": "pixel", + "namespace": "transmitting", + "value": "primary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.328Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.285Z", + "display_name": "kerluke-lowe.example", + "groups": [], + "id": "0907bf45-b228-460b-989a-8414b7429f12", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.285Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.285Z", + "tags": [ + { + "key": "bandwidth", + "namespace": "transmitting", + "value": "primary" + }, + { + "key": "bandwidth", + "namespace": "copying", + "value": "redundant" + }, + { + "key": "monitor", + "namespace": "compressing", + "value": "bluetooth" + }, + { + "key": "feed", + "namespace": "overriding", + "value": "1080p" + }, + { + "key": "alarm", + "namespace": "programming", + "value": "multi-byte" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.285Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.323Z", + "display_name": "torp.example", + "groups": [], + "id": "24c8942c-00d6-4456-9a9b-a820336a52c9", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.323Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.323Z", + "tags": [ + { + "key": "protocol", + "namespace": "bypassing", + "value": "mobile" + }, + { + "key": "monitor", + "namespace": "navigating", + "value": "virtual" + }, + { + "key": "application", + "namespace": "calculating", + "value": "open-source" + }, + { + "key": "program", + "namespace": "parsing", + "value": "mobile" + }, + { + "key": "program", + "namespace": "copying", + "value": "solid state" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.323Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.339Z", + "display_name": "schmitt.example", + "groups": [], + "id": "2869e663-5458-4387-ba82-14befcac7f30", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.339Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.339Z", + "tags": [ + { + "key": "matrix", + "namespace": "bypassing", + "value": "multi-byte" + }, + { + "key": "panel", + "namespace": "backing up", + "value": "1080p" + }, + { + "key": "alarm", + "namespace": "generating", + "value": "1080p" + }, + { + "key": "firewall", + "namespace": "indexing", + "value": "auxiliary" + }, + { + "key": "bus", + "namespace": "synthesizing", + "value": "auxiliary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.339Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.362Z", + "display_name": "thiel-rippin.test", + "groups": [], + "id": "2d6e53b6-ccdf-438d-9459-e79110c96887", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.362Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.362Z", + "tags": [ + { + "key": "pixel", + "namespace": "copying", + "value": "neural" + }, + { + "key": "firewall", + "namespace": "compressing", + "value": "online" + }, + { + "key": "transmitter", + "namespace": "generating", + "value": "virtual" + }, + { + "key": "firewall", + "namespace": "calculating", + "value": "online" + }, + { + "key": "sensor", + "namespace": "calculating", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.362Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.415Z", + "display_name": "marvin.test", + "groups": [], + "id": "2d81ffc6-2013-4e0c-9567-b6cb64ffb2fe", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.415Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.415Z", + "tags": [ + { + "key": "alarm", + "namespace": "transmitting", + "value": "multi-byte" + }, + { + "key": "capacitor", + "namespace": "transmitting", + "value": "bluetooth" + }, + { + "key": "transmitter", + "namespace": "hacking", + "value": "redundant" + }, + { + "key": "array", + "namespace": "bypassing", + "value": "solid state" + }, + { + "key": "monitor", + "namespace": "compressing", + "value": "cross-platform" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.415Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.400Z", + "display_name": "hauck.test", + "groups": [], + "id": "2daafe25-9771-4f58-ac85-03c16a8c49d9", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.400Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.400Z", + "tags": [ + { + "key": "protocol", + "namespace": "navigating", + "value": "online" + }, + { + "key": "capacitor", + "namespace": "transmitting", + "value": "primary" + }, + { + "key": "hard drive", + "namespace": "copying", + "value": "optical" + }, + { + "key": "application", + "namespace": "transmitting", + "value": "back-end" + }, + { + "key": "array", + "namespace": "connecting", + "value": "primary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.400Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.410Z", + "display_name": "balistreri.example", + "groups": [], + "id": "68c07652-be84-4c80-a9fa-76db6c07f620", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.410Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.410Z", + "tags": [ + { + "key": "circuit", + "namespace": "hacking", + "value": "mobile" + }, + { + "key": "array", + "namespace": "programming", + "value": "open-source" + }, + { + "key": "array", + "namespace": "compressing", + "value": "solid state" + }, + { + "key": "port", + "namespace": "indexing", + "value": "digital" + }, + { + "key": "bus", + "namespace": "calculating", + "value": "multi-byte" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.410Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.312Z", + "display_name": "goldner.example", + "groups": [], + "id": "6c44b88e-f0a7-4a23-9083-12ac3be9d4ce", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.312Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.312Z", + "tags": [ + { + "key": "capacitor", + "namespace": "copying", + "value": "back-end" + }, + { + "key": "capacitor", + "namespace": "copying", + "value": "primary" + }, + { + "key": "card", + "namespace": "programming", + "value": "cross-platform" + }, + { + "key": "transmitter", + "namespace": "hacking", + "value": "solid state" + }, + { + "key": "application", + "namespace": "parsing", + "value": "1080p" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.312Z" + } + ], + "links": { + "first": "/api/compliance/v2/policies/aff389b8-d1b9-4eb1-bd6b-8994902a1f99/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", + "last": "/api/compliance/v2/policies/aff389b8-d1b9-4eb1-bd6b-8994902a1f99/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", + "next": "/api/compliance/v2/policies/aff389b8-d1b9-4eb1-bd6b-8994902a1f99/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=10" + }, + "meta": { + "filter": "(os_minor_version=0)", + "limit": 10, + "offset": 0, + "tags": [], + "total": 25 + } + } + }, + "List of Systems sorted by \"os_minor_version:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:08.234Z", + "display_name": "carroll.example", + "groups": [], + "id": "0e3b36fc-7f02-4a9d-a4b4-7f8aac185ffb", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.234Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.234Z", + "tags": [ + { + "key": "alarm", + "namespace": "quantifying", + "value": "wireless" + }, + { + "key": "monitor", + "namespace": "navigating", + "value": "cross-platform" + }, + { + "key": "alarm", + "namespace": "connecting", + "value": "wireless" + }, + { + "key": "array", + "namespace": "connecting", + "value": "optical" + }, + { + "key": "driver", + "namespace": "parsing", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.234Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.154Z", + "display_name": "moore-bailey.example", + "groups": [], + "id": "14e92554-29fb-401f-befe-ad87733faf20", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.154Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.154Z", + "tags": [ + { + "key": "application", + "namespace": "synthesizing", + "value": "open-source" + }, + { + "key": "transmitter", + "namespace": "transmitting", + "value": "online" + }, + { + "key": "application", + "namespace": "transmitting", + "value": "back-end" + }, + { + "key": "sensor", + "namespace": "copying", + "value": "primary" + }, + { + "key": "capacitor", + "namespace": "synthesizing", + "value": "1080p" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.154Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.209Z", + "display_name": "farrell.test", + "groups": [], + "id": "1e43e243-bb97-44b2-8def-16c1da80ca72", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.209Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.209Z", + "tags": [ + { + "key": "hard drive", + "namespace": "hacking", + "value": "multi-byte" + }, + { + "key": "transmitter", + "namespace": "connecting", + "value": "virtual" + }, + { + "key": "microchip", + "namespace": "transmitting", + "value": "open-source" + }, + { + "key": "alarm", + "namespace": "programming", + "value": "haptic" + }, + { + "key": "panel", + "namespace": "transmitting", + "value": "back-end" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.209Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.214Z", + "display_name": "von.example", + "groups": [], + "id": "21f97f65-38df-4adc-ad9c-bf465e3b9694", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.214Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.214Z", + "tags": [ + { + "key": "feed", + "namespace": "bypassing", + "value": "redundant" + }, + { + "key": "pixel", + "namespace": "calculating", + "value": "neural" + }, + { + "key": "array", + "namespace": "copying", + "value": "solid state" + }, + { + "key": "application", + "namespace": "overriding", + "value": "primary" + }, + { + "key": "microchip", + "namespace": "hacking", + "value": "back-end" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.214Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.188Z", + "display_name": "hauck-bogisich.test", + "groups": [], + "id": "3a66bbd9-24a6-49fd-a459-861e723c6fff", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.188Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.188Z", + "tags": [ + { + "key": "circuit", + "namespace": "bypassing", + "value": "cross-platform" + }, + { + "key": "feed", + "namespace": "indexing", + "value": "neural" + }, + { + "key": "pixel", + "namespace": "synthesizing", + "value": "cross-platform" + }, + { + "key": "port", + "namespace": "calculating", + "value": "online" + }, + { + "key": "application", + "namespace": "parsing", + "value": "cross-platform" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.188Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.260Z", + "display_name": "bosco.test", + "groups": [], + "id": "3aa2b0f8-e967-4802-b011-c450d9ea447e", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.260Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.260Z", + "tags": [ + { + "key": "driver", + "namespace": "overriding", + "value": "cross-platform" + }, + { + "key": "capacitor", + "namespace": "navigating", + "value": "mobile" + }, + { + "key": "microchip", + "namespace": "parsing", + "value": "solid state" + }, + { + "key": "bandwidth", + "namespace": "parsing", + "value": "virtual" + }, + { + "key": "capacitor", + "namespace": "backing up", + "value": "optical" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.260Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.219Z", + "display_name": "reilly.example", + "groups": [], + "id": "46982a06-d7db-4c3e-832a-b4bc14679fa2", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.219Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.219Z", + "tags": [ + { + "key": "panel", + "namespace": "programming", + "value": "back-end" + }, + { + "key": "capacitor", + "namespace": "copying", + "value": "wireless" + }, + { + "key": "capacitor", + "namespace": "transmitting", + "value": "primary" + }, + { + "key": "driver", + "namespace": "backing up", + "value": "primary" + }, + { + "key": "matrix", + "namespace": "indexing", + "value": "optical" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.219Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.144Z", + "display_name": "rohan.test", + "groups": [], + "id": "4b6c7966-bf2c-457c-bea9-646c759eedbe", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.144Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.144Z", + "tags": [ + { + "key": "interface", + "namespace": "copying", + "value": "auxiliary" + }, + { + "key": "sensor", + "namespace": "overriding", + "value": "primary" + }, + { + "key": "microchip", + "namespace": "programming", + "value": "multi-byte" + }, + { + "key": "card", + "namespace": "compressing", + "value": "haptic" + }, + { + "key": "circuit", + "namespace": "bypassing", + "value": "primary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.144Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.240Z", + "display_name": "dibbert.test", + "groups": [], + "id": "4d1f4133-9d43-458b-8879-e8e4e4f95fd8", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.240Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.240Z", + "tags": [ + { + "key": "hard drive", + "namespace": "synthesizing", + "value": "online" + }, + { + "key": "application", + "namespace": "calculating", + "value": "online" + }, + { + "key": "program", + "namespace": "transmitting", + "value": "primary" + }, + { + "key": "transmitter", + "namespace": "quantifying", + "value": "back-end" + }, + { + "key": "pixel", + "namespace": "calculating", + "value": "haptic" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.240Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.182Z", + "display_name": "gorczany.test", + "groups": [], + "id": "4e5ab2ca-d144-4e9d-90fb-236bc98a5ae0", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.182Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.182Z", + "tags": [ + { + "key": "system", + "namespace": "bypassing", + "value": "online" + }, + { + "key": "capacitor", + "namespace": "backing up", + "value": "optical" + }, + { + "key": "circuit", + "namespace": "indexing", + "value": "digital" + }, + { + "key": "monitor", + "namespace": "synthesizing", + "value": "wireless" + }, + { + "key": "application", + "namespace": "calculating", + "value": "online" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.182Z" + } + ], + "links": { + "first": "/api/compliance/v2/policies/0d17f9ff-2b79-4a90-ad65-9851b899e142/systems?limit=10&offset=0&sort_by=os_minor_version", + "last": "/api/compliance/v2/policies/0d17f9ff-2b79-4a90-ad65-9851b899e142/systems?limit=10&offset=20&sort_by=os_minor_version", + "next": "/api/compliance/v2/policies/0d17f9ff-2b79-4a90-ad65-9851b899e142/systems?limit=10&offset=10&sort_by=os_minor_version" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "os_minor_version", + "tags": [], + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/system" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Systems assigned to a Policy" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Systems assigned to a Policy", + "tags": [ + "Policies" + ] + }, + "post": { + "deprecated": true, + "description": "This feature is exclusively used by the frontend", + "operationId": "AssignSystems", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "ids": { + "items": { + "examples": [ + "e7de0701-d540-4bd2-a898-00df28c7dbf5" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of assigned Systems": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:08.918Z", + "display_name": "ruecker.example", + "groups": [], + "id": "234bf987-a93a-4f96-b63e-1226db6db875", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.918Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.918Z", + "tags": [ + { + "key": "matrix", + "namespace": "synthesizing", + "value": "bluetooth" + }, + { + "key": "matrix", + "namespace": "compressing", + "value": "wireless" + }, + { + "key": "bandwidth", + "namespace": "bypassing", + "value": "1080p" + }, + { + "key": "microchip", + "namespace": "programming", + "value": "optical" + }, + { + "key": "panel", + "namespace": "parsing", + "value": "solid state" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.918Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.905Z", + "display_name": "toy.test", + "groups": [], + "id": "319f1b3c-4b43-4c0e-9183-0fbbaf3f26b0", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.905Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.905Z", + "tags": [ + { + "key": "hard drive", + "namespace": "bypassing", + "value": "multi-byte" + }, + { + "key": "feed", + "namespace": "hacking", + "value": "auxiliary" + }, + { + "key": "interface", + "namespace": "indexing", + "value": "online" + }, + { + "key": "microchip", + "namespace": "quantifying", + "value": "redundant" + }, + { + "key": "interface", + "namespace": "copying", + "value": "open-source" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.905Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.909Z", + "display_name": "franecki.test", + "groups": [], + "id": "325c430d-01aa-4ea3-b60f-016262de9277", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.909Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.909Z", + "tags": [ + { + "key": "capacitor", + "namespace": "compressing", + "value": "solid state" + }, + { + "key": "transmitter", + "namespace": "navigating", + "value": "haptic" + }, + { + "key": "sensor", + "namespace": "synthesizing", + "value": "digital" + }, + { + "key": "pixel", + "namespace": "overriding", + "value": "cross-platform" + }, + { + "key": "monitor", + "namespace": "overriding", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.909Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.908Z", + "display_name": "powlowski-hane.test", + "groups": [], + "id": "3612cfbc-91ba-42a7-bf29-4b2d3d2a2448", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.908Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.908Z", + "tags": [ + { + "key": "firewall", + "namespace": "calculating", + "value": "solid state" + }, + { + "key": "interface", + "namespace": "overriding", + "value": "neural" + }, + { + "key": "interface", + "namespace": "parsing", + "value": "cross-platform" + }, + { + "key": "transmitter", + "namespace": "parsing", + "value": "cross-platform" + }, + { + "key": "firewall", + "namespace": "indexing", + "value": "mobile" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.908Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.899Z", + "display_name": "donnelly-fay.example", + "groups": [], + "id": "425c8546-cc0c-46ad-bc85-d98af3a76b4c", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.899Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.899Z", + "tags": [ + { + "key": "capacitor", + "namespace": "transmitting", + "value": "1080p" + }, + { + "key": "alarm", + "namespace": "compressing", + "value": "auxiliary" + }, + { + "key": "transmitter", + "namespace": "transmitting", + "value": "haptic" + }, + { + "key": "port", + "namespace": "navigating", + "value": "wireless" + }, + { + "key": "bus", + "namespace": "overriding", + "value": "optical" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.899Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.903Z", + "display_name": "block-nikolaus.test", + "groups": [], + "id": "4ee76d1c-6965-4c43-8ec1-da5b681300f8", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.903Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.903Z", + "tags": [ + { + "key": "bandwidth", + "namespace": "indexing", + "value": "online" + }, + { + "key": "bandwidth", + "namespace": "transmitting", + "value": "open-source" + }, + { + "key": "transmitter", + "namespace": "backing up", + "value": "redundant" + }, + { + "key": "sensor", + "namespace": "synthesizing", + "value": "open-source" + }, + { + "key": "feed", + "namespace": "indexing", + "value": "neural" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.903Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.901Z", + "display_name": "swaniawski-fadel.example", + "groups": [], + "id": "50d6bf18-fef8-4587-b918-9f94625c9016", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.901Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.901Z", + "tags": [ + { + "key": "matrix", + "namespace": "compressing", + "value": "multi-byte" + }, + { + "key": "panel", + "namespace": "connecting", + "value": "virtual" + }, + { + "key": "firewall", + "namespace": "calculating", + "value": "auxiliary" + }, + { + "key": "pixel", + "namespace": "generating", + "value": "optical" + }, + { + "key": "port", + "namespace": "bypassing", + "value": "back-end" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.901Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.912Z", + "display_name": "quitzon.example", + "groups": [], + "id": "51090cae-8688-4404-ba0f-56f06098d8c6", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.912Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.912Z", + "tags": [ + { + "key": "port", + "namespace": "transmitting", + "value": "multi-byte" + }, + { + "key": "circuit", + "namespace": "quantifying", + "value": "auxiliary" + }, + { + "key": "bus", + "namespace": "backing up", + "value": "open-source" + }, + { + "key": "pixel", + "namespace": "calculating", + "value": "optical" + }, + { + "key": "port", + "namespace": "generating", + "value": "neural" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.912Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.905Z", + "display_name": "lemke-labadie.test", + "groups": [], + "id": "52e6d50d-dc26-42bb-af23-eed0eb4a0e41", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.905Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.905Z", + "tags": [ + { + "key": "matrix", + "namespace": "synthesizing", + "value": "neural" + }, + { + "key": "microchip", + "namespace": "transmitting", + "value": "digital" + }, + { + "key": "firewall", + "namespace": "copying", + "value": "haptic" + }, + { + "key": "program", + "namespace": "compressing", + "value": "virtual" + }, + { + "key": "pixel", + "namespace": "transmitting", + "value": "wireless" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.905Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:08.913Z", + "display_name": "hudson.example", + "groups": [], + "id": "57b0da00-cf2f-4017-a502-6b5e555d4182", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:08.913Z", + "stale_warning_timestamp": "2034-11-30T09:30:08.913Z", + "tags": [ + { + "key": "port", + "namespace": "hacking", + "value": "auxiliary" + }, + { + "key": "monitor", + "namespace": "calculating", + "value": "auxiliary" + }, + { + "key": "alarm", + "namespace": "quantifying", + "value": "1080p" + }, + { + "key": "circuit", + "namespace": "calculating", + "value": "solid state" + }, + { + "key": "application", + "namespace": "copying", + "value": "bluetooth" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:08.913Z" + } + ], + "links": { + "first": "/api/compliance/v2/policies/f6e5c572-f161-4900-9882-2d360d592c60/systems?limit=10&offset=0", + "last": "/api/compliance/v2/policies/f6e5c572-f161-4900-9882-2d360d592c60/systems?limit=10&offset=20", + "next": "/api/compliance/v2/policies/f6e5c572-f161-4900-9882-2d360d592c60/systems?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "tags": [], + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/system" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Assigns all specified systems and unassigns the rest" + } + }, + "summary": "Bulk assign Systems to a Policy", + "tags": [ + "Policies" + ] + } + }, + "/policies/{policy_id}/systems/os_versions": { + "get": { + "deprecated": true, + "description": "This feature is exclusively used by the frontend", + "operationId": "PolicySystemsOS", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_version`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `never_reported`, `group_name`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of available OS versions": { + "description": "", + "summary": "", + "value": [ + "8.0" + ] + } + }, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "description": "Lists available OS versions" + } + }, + "summary": "Request the list of available OS versions", + "tags": [ + "Systems" + ] + } + }, + "/policies/{policy_id}/systems/{system_id}": { + "delete": { + "description": "Remove a specific system from a specific policy.", + "operationId": "UnassignSystem", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "system_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "Unassigns a System from a Policy": { + "description": "", + "summary": "", + "value": { + "data": { + "culled_timestamp": "2034-12-07T09:30:09.164Z", + "display_name": "wilkinson-price.test", + "groups": [], + "id": "98c0f7c4-3e06-4c46-aa08-07033a535285", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:09.164Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.164Z", + "tags": [ + { + "key": "monitor", + "namespace": "synthesizing", + "value": "cross-platform" + }, + { + "key": "monitor", + "namespace": "synthesizing", + "value": "haptic" + }, + { + "key": "program", + "namespace": "connecting", + "value": "online" + }, + { + "key": "card", + "namespace": "calculating", + "value": "digital" + }, + { + "key": "interface", + "namespace": "transmitting", + "value": "solid state" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.164Z" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/system" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Unassigns a System from a Policy" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when unassigning a non-existing System": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::System not found with ID d8f0f8e9-ed18-43e6-88f4-15ce22a7a379" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Unassign a System from a Policy", + "tags": [ + "Policies" + ] + }, + "patch": { + "description": "Assign a specific system to a specific policy.", + "operationId": "AssignSystem", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "system_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "Assigns a System to a Policy": { + "description": "", + "summary": "", + "value": { + "data": { + "culled_timestamp": "2034-12-07T09:30:09.114Z", + "display_name": "towne.example", + "groups": [], + "id": "8e6496f7-1fc3-4a88-abce-0da3c0b1a671", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "stale_timestamp": "2034-11-23T09:30:09.114Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.114Z", + "tags": [ + { + "key": "monitor", + "namespace": "compressing", + "value": "back-end" + }, + { + "key": "microchip", + "namespace": "parsing", + "value": "redundant" + }, + { + "key": "transmitter", + "namespace": "compressing", + "value": "back-end" + }, + { + "key": "array", + "namespace": "navigating", + "value": "online" + }, + { + "key": "bus", + "namespace": "compressing", + "value": "solid state" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.114Z" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/system" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Assigns a System to a Policy" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Assigns a System to a Policy": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::System not found with ID 305bef61-48d5-4639-b5c9-f086bc3f5dc0" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Assign a System to a Policy", + "tags": [ + "Policies" + ] + } + }, + "/policies/{policy_id}/tailorings": { + "get": { + "description": "Retrieve a list of all tailorings.", + "operationId": "Tailorings", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "os_minor_version", + "os_minor_version:asc", + "os_minor_version:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Tailorings are searchable using attributes `os_minor_version`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Tailorings": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "id": "06ef057f-dfcd-4fe9-8a9c-49c8ac01ef64", + "os_major_version": 7, + "os_minor_version": 11, + "profile_id": "a6f68007-4c3a-49b8-98f6-6bed3e334a6e", + "security_guide_id": "a5f536b2-9c3d-430c-b376-ea8ffae2d765", + "security_guide_version": "100.95.40", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "1225d382-59aa-47ef-aecb-57def034532e", + "os_major_version": 7, + "os_minor_version": 6, + "profile_id": "6e2120b1-cb78-4b9a-82dd-f13073e5b52b", + "security_guide_id": "08331e69-dbb3-4fcc-9612-4fb7333c9ece", + "security_guide_version": "100.95.35", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "1c735705-03cf-4c39-95b8-92c3b8816375", + "os_major_version": 7, + "os_minor_version": 17, + "profile_id": "dca56ed4-b608-495c-b9e5-826f9e62c608", + "security_guide_id": "bd32c197-94ae-4042-8278-304934511ae1", + "security_guide_version": "100.95.46", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "24c62cd0-51ef-4c66-8c5b-7a47992e9584", + "os_major_version": 7, + "os_minor_version": 2, + "profile_id": "94d1984d-a446-44df-a3ac-6cf6733e5618", + "security_guide_id": "847d53d8-a04c-4460-99b2-61e8adfa5297", + "security_guide_version": "100.95.31", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "393bbad5-fb80-4fc6-aace-939b469443a1", + "os_major_version": 7, + "os_minor_version": 10, + "profile_id": "5e5d60f2-21c0-4922-9c8b-e9bb5f0ae8e0", + "security_guide_id": "541a0cac-0b6f-4b4b-b27a-dccce90cc2f9", + "security_guide_version": "100.95.39", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "3aad6a6d-6ddd-42d8-98aa-d6943fc4cdfb", + "os_major_version": 7, + "os_minor_version": 22, + "profile_id": "315e2821-4631-487d-b455-60d832b8b7b3", + "security_guide_id": "3f87045e-0907-4fa5-9cb7-373ae80775ed", + "security_guide_version": "100.96.1", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "419e5279-78f8-47c7-9115-8a622e0e6ce5", + "os_major_version": 7, + "os_minor_version": 20, + "profile_id": "c72f3d78-b5b4-4d6e-8e02-48059b7748db", + "security_guide_id": "6a2f865d-7b17-426b-9691-b1cef5629f33", + "security_guide_version": "100.95.49", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "43fbf0b3-9da5-4e6c-a5c3-80aa2b6089b6", + "os_major_version": 7, + "os_minor_version": 14, + "profile_id": "fb5b1528-49a0-4f05-8116-f8db491ab9a9", + "security_guide_id": "acb08f51-d82a-4dc0-9739-8e3841e21666", + "security_guide_version": "100.95.43", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "47ea3104-464d-45d5-a1d5-8f8343caa71f", + "os_major_version": 7, + "os_minor_version": 9, + "profile_id": "9b0c2b59-c737-4475-8ba7-2a285a970cb2", + "security_guide_id": "3962e625-f3a2-43fb-9833-861fc1b829c9", + "security_guide_version": "100.95.38", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "4983d5af-ae27-470a-a0d4-5a7b9013384d", + "os_major_version": 7, + "os_minor_version": 23, + "profile_id": "c8bc23e9-1bad-4f54-8ca5-321724a7c39b", + "security_guide_id": "11deebb9-f9a8-4189-b2ee-a36950258ac2", + "security_guide_version": "100.96.2", + "type": "tailoring", + "value_overrides": {} + } + ], + "links": { + "first": "/api/compliance/v2/policies/3b9a7430-27eb-4a17-b70c-8554e08f5529/tailorings?limit=10&offset=0", + "last": "/api/compliance/v2/policies/3b9a7430-27eb-4a17-b70c-8554e08f5529/tailorings?limit=10&offset=20", + "next": "/api/compliance/v2/policies/3b9a7430-27eb-4a17-b70c-8554e08f5529/tailorings?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + }, + "List of Tailorings filtered by '(os_minor_version=18)'": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "id": "21b09b11-06b0-49ee-a2b3-ab8f79eed544", + "os_major_version": 7, + "os_minor_version": 18, + "profile_id": "9b08e719-ce6f-4aae-b8df-8001abfb6552", + "security_guide_id": "3a47d5f0-20ac-4ff4-8175-820a006dcd2a", + "security_guide_version": "100.96.47", + "type": "tailoring", + "value_overrides": {} + } + ], + "links": { + "first": "/api/compliance/v2/policies/fcada9d2-165d-4bed-8997-e102c9cf299c/tailorings?filter=%28os_minor_version%3D18%29&limit=10&offset=0", + "last": "/api/compliance/v2/policies/fcada9d2-165d-4bed-8997-e102c9cf299c/tailorings?filter=%28os_minor_version%3D18%29&limit=10&offset=0" + }, + "meta": { + "filter": "(os_minor_version=18)", + "limit": 10, + "offset": 0, + "total": 1 + } + } + }, + "List of Tailorings sorted by \"os_minor_version:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "id": "37fd4b8a-420a-4b1a-b14f-9c204c92cd77", + "os_major_version": 7, + "os_minor_version": 0, + "profile_id": "642edda3-39b6-4b07-81f1-f266ea978cfe", + "security_guide_id": "bd109768-9740-4a3a-8b46-fafb85cf9599", + "security_guide_version": "100.96.4", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "2a070360-059e-4a68-998e-69f17a1410ac", + "os_major_version": 7, + "os_minor_version": 1, + "profile_id": "6416018b-5f8b-4633-b729-ebe7618d4bd7", + "security_guide_id": "5b8fd4d8-5ee0-4cec-a30b-a17130f777c9", + "security_guide_version": "100.96.5", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "23cf8afa-ea43-4ba8-9a1d-d34cf8b12e6e", + "os_major_version": 7, + "os_minor_version": 2, + "profile_id": "6ddbf3a8-6a2d-47a6-bf5c-b00a82496960", + "security_guide_id": "a0c8d62d-2295-4ca0-a55a-7d4e24937869", + "security_guide_version": "100.96.6", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "85620130-ae3d-4e05-9dd5-2f366d55230d", + "os_major_version": 7, + "os_minor_version": 3, + "profile_id": "63449913-37bb-4caa-9c2a-617b25b6302d", + "security_guide_id": "b5a12b24-9d9e-40df-ad0b-892ac49bf0dd", + "security_guide_version": "100.96.7", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "042dcdb1-e7fc-4f08-b8d0-72756587c11a", + "os_major_version": 7, + "os_minor_version": 4, + "profile_id": "35b87893-7dbd-4b9f-8a31-be584f858983", + "security_guide_id": "94f1de5e-dd29-4008-9a6c-a212101fba81", + "security_guide_version": "100.96.8", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "4e924eae-17b2-4fca-aff6-5925d0e81612", + "os_major_version": 7, + "os_minor_version": 5, + "profile_id": "e6fb4fd8-cf76-4a48-9e71-0078f20fb458", + "security_guide_id": "efa516c9-445e-41f2-933d-748f56367ba1", + "security_guide_version": "100.96.9", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "c9fccca6-1a13-45c8-ba12-1ec4a41f93b0", + "os_major_version": 7, + "os_minor_version": 6, + "profile_id": "22bf2cbc-6510-4c79-bf83-ef7dc767c932", + "security_guide_id": "7d0f293e-4b4e-4a4a-b10c-74bae82030f3", + "security_guide_version": "100.96.10", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "864f3ed1-664e-4af4-8a48-27fb5a98ef9f", + "os_major_version": 7, + "os_minor_version": 7, + "profile_id": "364b70d6-9bc2-44e5-90cf-8509c8d4034d", + "security_guide_id": "713a91f6-7c09-49f4-9d73-92984b5c2c6e", + "security_guide_version": "100.96.11", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "e334658d-739a-49dd-9dab-00f83d5be0cd", + "os_major_version": 7, + "os_minor_version": 8, + "profile_id": "f93f7f24-e56c-47c3-865c-198d6787aa39", + "security_guide_id": "647e70d0-aa2c-407c-b1e0-e444a4222c51", + "security_guide_version": "100.96.12", + "type": "tailoring", + "value_overrides": {} + }, + { + "id": "b1551fe1-c020-46b2-be77-bbd0291a5ce1", + "os_major_version": 7, + "os_minor_version": 9, + "profile_id": "fdd66a43-fa59-4336-a0a8-23800a33c63d", + "security_guide_id": "fdb0d3d8-5890-46e9-a8f2-149f9f0bedae", + "security_guide_version": "100.96.13", + "type": "tailoring", + "value_overrides": {} + } + ], + "links": { + "first": "/api/compliance/v2/policies/0c9432e5-b693-46b3-8a3f-640d433b16c6/tailorings?limit=10&offset=0&sort_by=os_minor_version", + "last": "/api/compliance/v2/policies/0c9432e5-b693-46b3-8a3f-640d433b16c6/tailorings?limit=10&offset=20&sort_by=os_minor_version", + "next": "/api/compliance/v2/policies/0c9432e5-b693-46b3-8a3f-640d433b16c6/tailorings?limit=10&offset=10&sort_by=os_minor_version" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "os_minor_version", + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/tailoring" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Tailorings" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Tailorings", + "tags": [ + "Policies" + ] + }, + "post": { + "deprecated": true, + "description": "Create a Tailoring with the provided attributes (for ImageBuilder only)", + "operationId": "CreateTailoring", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/tailoring_create" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "examples": { + "Response example": { + "description": "", + "summary": "", + "value": { + "data": { + "id": "b87f00a2-2fa6-4df5-a9fa-1e7f3b49df08", + "os_major_version": 7, + "os_minor_version": 1, + "profile_id": "98befc9a-572b-46aa-b127-76b66edf2c20", + "security_guide_id": "4e44b6c3-c36e-41e8-9a50-ddf3ec73c312", + "security_guide_version": "100.98.4", + "type": "tailoring", + "value_overrides": {} + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/tailoring" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Creates a Tailoring" + } + }, + "summary": "Create a Tailoring", + "tags": [ + "Policies" + ] + } + }, + "/policies/{policy_id}/tailorings/{tailoring_id}": { + "get": { + "description": "Retrieve a specific tailoring.", + "operationId": "Tailoring", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "UUID or OS minor version number", + "in": "path", + "name": "tailoring_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Tailoring": { + "description": "", + "summary": "", + "value": { + "data": { + "id": "14c41d27-8857-4f15-b765-77f56dc7d731", + "os_major_version": 7, + "os_minor_version": 1, + "profile_id": "b93c7d11-0bde-43d7-a128-5a55e2027804", + "security_guide_id": "028806a9-05b5-40fa-8cb5-34f8a8e9d886", + "security_guide_version": "100.98.5", + "type": "tailoring", + "value_overrides": {} + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/tailoring" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Tailoring" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Tailoring": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Tailoring not found with ID 6d14bf0f-72e5-4a59-994f-95cabfab2702" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Tailoring", + "tags": [ + "Policies" + ] + }, + "patch": { + "description": "Edit or update an existing tailoring.", + "operationId": "UpdateTailoring", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "UUID or OS minor version number", + "in": "path", + "name": "tailoring_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/tailoring" + } + } + } + }, + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns the updated Tailoring": { + "description": "", + "summary": "", + "value": { + "data": { + "id": "5bfebb5f-112e-4fee-ac1a-8556b782a7b7", + "os_major_version": 7, + "os_minor_version": 1, + "profile_id": "aa64cda3-9c2d-4b22-b034-349552ced71c", + "security_guide_id": "891ae942-519e-4141-a2b9-e475119041ef", + "security_guide_version": "100.98.6", + "type": "tailoring", + "value_overrides": { + "87660867-d806-4ddd-8795-8947c51849b4": "123" + } + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/tailoring" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Updates a Tailoring" + } + }, + "summary": "Update a Tailoring", + "tags": [ + "Policies" + ] + } + }, + "/policies/{policy_id}/tailorings/{tailoring_id}/rule_tree": { + "get": { + "deprecated": true, + "description": "Returns rule tree of a tailoring.", + "operationId": "TailoringRuleTree", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "tailoring_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns the Rule Tree of a Tailoring": { + "description": "", + "summary": "", + "value": [ + { + "children": [ + { + "id": "410524f4-1c41-4702-b156-d48126ad9bf1", + "type": "rule" + } + ], + "id": "2b286d51-b026-4196-b1fe-f587a1203eea", + "type": "rule_group" + }, + { + "children": [ + { + "id": "2cf28d23-c4fd-4f7c-afa9-857587ad6e83", + "type": "rule" + } + ], + "id": "b125f721-3a99-43d4-8948-405c5b332a29", + "type": "rule_group" + }, + { + "children": [ + { + "id": "43225e31-51f6-487b-b4f2-06132f5ae3a7", + "type": "rule" + } + ], + "id": "90b94b4d-8cfe-46da-84b4-1235e455e64e", + "type": "rule_group" + }, + { + "children": [ + { + "id": "9daf859f-9cd9-4e94-928f-4a600522bf48", + "type": "rule" + } + ], + "id": "d52b0b32-88c5-4f8e-9312-77cf3f563fb0", + "type": "rule_group" + }, + { + "children": [ + { + "id": "5484ef57-0de5-404a-9587-eb1e552b2e08", + "type": "rule" + } + ], + "id": "296daa93-7d77-43a0-846f-bdb3cf5eaf88", + "type": "rule_group" + }, + { + "children": [ + { + "id": "8810c953-e48a-4138-abf9-2ea917820ccd", + "type": "rule" + } + ], + "id": "e5a3b13e-6dc4-47e7-b0e1-4fca15bbfd1c", + "type": "rule_group" + }, + { + "children": [ + { + "id": "4efb0ed5-2525-4136-975f-564e0beb69b6", + "type": "rule" + } + ], + "id": "dc51660b-deab-4cb5-9cde-1165e1137794", + "type": "rule_group" + }, + { + "children": [ + { + "id": "4b02ccdb-cbc5-4a8d-8c13-fc33226b6c86", + "type": "rule" + } + ], + "id": "9682df8d-7984-43ca-a151-5d53439febc1", + "type": "rule_group" + }, + { + "children": [ + { + "id": "e546b2db-8a6a-4f37-bb37-f531da2ebcdc", + "type": "rule" + } + ], + "id": "d0171699-ab26-4cba-929a-6125ba5ad1e4", + "type": "rule_group" + }, + { + "children": [ + { + "id": "0e8fb956-1f1f-48e5-832b-0bc45717cbb1", + "type": "rule" + } + ], + "id": "0b1be316-3c74-4b42-a36d-495569a1a745", + "type": "rule_group" + } + ] + } + }, + "schema": { + "$ref": "#/components/schemas/rule_tree" + } + } + }, + "description": "Returns the Rule Tree of a Tailoring" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Tailoring": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Tailoring not found with ID 605c5ca9-3a1b-4c79-a042-ac6cdc0499a9" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request the Rule Tree of a Tailoring", + "tags": [ + "Policies" + ] + } + }, + "/policies/{policy_id}/tailorings/{tailoring_id}/rules": { + "get": { + "description": "Retrieve a list of rules relating to specific tailorings.", + "operationId": "TailoringRules", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "severity", + "precedence", + "remediation_available", + "title:asc", + "title:desc", + "severity:asc", + "severity:desc", + "precedence:asc", + "precedence:desc", + "remediation_available:asc", + "remediation_available:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rules are searchable using attributes `title`, `severity`, `remediation_available`, and `rule_group_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "tailoring_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Rules": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Accusamus deserunt in. Eaque omnis debitis. Dicta illo vero.", + "id": "2432672c-c7f3-46de-8e2e-a4fbc6f354d5", + "identifier": { + "href": "http://rau-cummings.test/israel.dibbert", + "label": "Larnach" + }, + "precedence": 1338, + "rationale": "Sit earum modi. Consectetur temporibus accusamus. Velit optio qui.", + "ref_id": "xccdf_org.ssgproject.content_rule_4a78169e78857f3e640580e2344f6938", + "references": [ + { + "href": "http://wunsch.test/noe", + "label": "Beldis" + }, + { + "href": "http://rippin-hane.example/hilma_erdman", + "label": "Nimrodel" + }, + { + "href": "http://botsford.test/teressa.rosenbaum", + "label": "Tar-Meneldur" + }, + { + "href": "http://anderson.example/ladonna.von", + "label": "Inziladûn" + }, + { + "href": "http://wolff.test/jenelle_sawayn", + "label": "Isilmo" + } + ], + "remediation_available": false, + "rule_group_id": "ed6d0150-9c18-45e4-9c0c-881b6da2a33d", + "severity": "low", + "title": "Nobis quod expedita architecto.", + "type": "rule", + "value_checks": null + } + ], + "links": { + "first": "/api/compliance/v2/policies/b30c6eb4-47a2-429e-90eb-a45e982fed63/tailorings/13b547a7-9ebf-4378-9d3e-29eaa51e7804/rules?limit=10&offset=0", + "last": "/api/compliance/v2/policies/b30c6eb4-47a2-429e-90eb-a45e982fed63/tailorings/13b547a7-9ebf-4378-9d3e-29eaa51e7804/rules?limit=10&offset=0" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 1 + } + } + }, + "List of Rules sorted by \"precedence:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Voluptas natus hic. Hic enim sit. Eos voluptatem animi.", + "id": "9a0405d5-4adc-47b4-afcd-a935c0e2070b", + "identifier": { + "href": "http://bogisich.test/hai", + "label": "Dora Baggins" + }, + "precedence": 7549, + "rationale": "Minus ipsum et. Illo cumque enim. Quis ea modi.", + "ref_id": "xccdf_org.ssgproject.content_rule_4c0c0cbf301ce98add29d8e40a84987a", + "references": [ + { + "href": "http://yundt-casper.test/chuck_towne", + "label": "Amlaith" + }, + { + "href": "http://volkman.example/cesar_damore", + "label": "Idis" + }, + { + "href": "http://kris-howell.test/florencia_ferry", + "label": "Argeleb" + }, + { + "href": "http://barton.example/lynell.ebert", + "label": "Borthand" + }, + { + "href": "http://mclaughlin.test/tod", + "label": "Treebeard" + } + ], + "remediation_available": false, + "rule_group_id": "3d55a216-060d-4574-b7e5-fcf34f03b923", + "severity": "medium", + "title": "Quam qui alias in.", + "type": "rule", + "value_checks": null + } + ], + "links": { + "first": "/api/compliance/v2/policies/093293ca-f719-4e35-a242-305433bfc6cb/tailorings/3bf3c6a8-d254-48ad-9781-04428f99ec1a/rules?limit=10&offset=0&sort_by=precedence", + "last": "/api/compliance/v2/policies/093293ca-f719-4e35-a242-305433bfc6cb/tailorings/3bf3c6a8-d254-48ad-9781-04428f99ec1a/rules?limit=10&offset=0&sort_by=precedence" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "precedence", + "total": 1 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/rule" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Rules assigned to a Tailoring" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Rules assigned to a Tailoring", + "tags": [ + "Policies" + ] + }, + "post": { + "deprecated": true, + "description": "This feature is exclusively used by the frontend", + "operationId": "AssignRules", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "tailoring_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "ids": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of assigned Rules": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Et minima nihil. Et vel facilis. Mollitia reprehenderit suscipit.", + "id": "0eb54eca-e109-440c-a36a-28a653fe9f82", + "identifier": { + "href": "http://frami.example/manuel", + "label": "King of the Dead" + }, + "precedence": 1506, + "rationale": "Quia pariatur dolor. Qui doloremque non. Magnam nam sed.", + "ref_id": "xccdf_org.ssgproject.content_rule_af94b042de29bf8f4d665cb0e9d1a98d", + "references": [ + { + "href": "http://abernathy.example/granville.vandervort", + "label": "Erkenbrand" + }, + { + "href": "http://hansen-tromp.test/talia", + "label": "Haldar" + }, + { + "href": "http://hills.test/shelby", + "label": "Celebrían" + }, + { + "href": "http://kub-bernier.test/hettie", + "label": "Hobson" + }, + { + "href": "http://johns.test/benjamin", + "label": "William" + } + ], + "remediation_available": false, + "rule_group_id": "1a21326b-c3ad-4d85-9869-cd113f3b83d0", + "severity": "high", + "title": "Et qui quidem enim.", + "type": "rule", + "value_checks": null + }, + { + "description": "Enim expedita ullam. Corrupti aut quo. Maiores excepturi quia.", + "id": "1a57713c-57ef-4910-8c64-13abcd11c550", + "identifier": { + "href": "http://kunde.test/leigh", + "label": "Siriondil" + }, + "precedence": 9500, + "rationale": "Nulla suscipit voluptates. Rerum nisi quis. Deleniti consequatur quia.", + "ref_id": "xccdf_org.ssgproject.content_rule_7159d0d01fe1deaaac45c123568c8a0e", + "references": [ + { + "href": "http://ortiz.example/susannah.dibbert", + "label": "Daisy Baggins" + }, + { + "href": "http://schaden-ankunding.example/alfred", + "label": "Celeborn" + }, + { + "href": "http://oreilly.example/jenice.cummings", + "label": "Dori" + }, + { + "href": "http://krajcik.example/art", + "label": "Indis" + }, + { + "href": "http://fay.example/merle", + "label": "Mosco Burrows" + } + ], + "remediation_available": false, + "rule_group_id": "66bcfacf-ce12-47ad-9d54-e69fa60bd930", + "severity": "low", + "title": "Labore excepturi qui voluptate.", + "type": "rule", + "value_checks": null + }, + { + "description": "Libero error dolores. Sequi velit veniam. Eveniet recusandae culpa.", + "id": "1cd3b8b0-6382-42ef-b293-85c50ff8f1b5", + "identifier": { + "href": "http://feil.example/darin", + "label": "Bowman Cotton" + }, + "precedence": 2388, + "rationale": "Et et commodi. Delectus et et. Doloremque eius quo.", + "ref_id": "xccdf_org.ssgproject.content_rule_ec827c07562798de214b4c4a76e2d1ea", + "references": [ + { + "href": "http://von-schmidt.example/milo", + "label": "Emeldir" + }, + { + "href": "http://mante.example/reed.quigley", + "label": "Amlach" + }, + { + "href": "http://turcotte.test/winford.gislason", + "label": "Otho Sackville-Baggins" + }, + { + "href": "http://nienow-lebsack.test/leandro_kihn", + "label": "Robin Smallburrow" + }, + { + "href": "http://stiedemann.test/toya", + "label": "Malach" + } + ], + "remediation_available": false, + "rule_group_id": "6972c1eb-ac13-4a71-aaf6-3b5757a5d399", + "severity": "high", + "title": "Voluptatibus repellat veritatis id.", + "type": "rule", + "value_checks": null + }, + { + "description": "Harum quasi praesentium. Explicabo culpa et. Est quia expedita.", + "id": "2665369c-187e-4b11-ad4a-0c802b89c912", + "identifier": { + "href": "http://halvorson-wunsch.test/geoffrey.simonis", + "label": "Enel" + }, + "precedence": 9264, + "rationale": "Blanditiis consequuntur aspernatur. Velit quaerat et. Officia laudantium eum.", + "ref_id": "xccdf_org.ssgproject.content_rule_f8ece0df20bb6ffce861d52c0ffb486a", + "references": [ + { + "href": "http://oreilly.example/elna.fadel", + "label": "Bucca of the Marish" + }, + { + "href": "http://bosco.test/earle", + "label": "Ulrad" + }, + { + "href": "http://wunsch.test/alina.ohara", + "label": "Orgulas Brandybuck" + }, + { + "href": "http://wisozk.test/frankie", + "label": "Aratan" + }, + { + "href": "http://swift.example/tilda", + "label": "Mungo Baggins" + } + ], + "remediation_available": false, + "rule_group_id": "f8139677-dc1e-4ab5-ae5c-1d6b4d62e1ae", + "severity": "low", + "title": "At vitae reprehenderit sed.", + "type": "rule", + "value_checks": null + }, + { + "description": "Sint earum temporibus. Porro consectetur et. Esse et unde.", + "id": "4b1fa9b2-7d4b-4d75-be6f-1382a3a37e72", + "identifier": { + "href": "http://oreilly.test/laveta", + "label": "Ghân-buri-Ghân" + }, + "precedence": 3544, + "rationale": "Quam qui placeat. Vero doloremque ut. Ea esse ea.", + "ref_id": "xccdf_org.ssgproject.content_rule_7a76b16fd29e3e02071bb46c5f8aa17a", + "references": [ + { + "href": "http://kris.test/luther", + "label": "Aratan" + }, + { + "href": "http://bartoletti-koelpin.example/hilton.corwin", + "label": "Bowman Cotton" + }, + { + "href": "http://murphy.test/gala.rau", + "label": "Frerin" + }, + { + "href": "http://hahn-hane.test/norman_dibbert", + "label": "Tosto Boffin" + }, + { + "href": "http://wunsch.example/joselyn.terry", + "label": "Ragnor" + } + ], + "remediation_available": false, + "rule_group_id": "2533ecfc-d77a-4eea-ad06-16b1b8d9e8a6", + "severity": "low", + "title": "Rerum commodi in soluta.", + "type": "rule", + "value_checks": null + }, + { + "description": "Et voluptatem ut. Exercitationem vitae delectus. Et et velit.", + "id": "4e014ee6-016d-4368-ac9c-022719676466", + "identifier": { + "href": "http://corkery-davis.example/shaunte", + "label": "Gram" + }, + "precedence": 4843, + "rationale": "A consequuntur praesentium. Neque soluta harum. Eum ut et.", + "ref_id": "xccdf_org.ssgproject.content_rule_5124402ce9606bced3849acbc6835798", + "references": [ + { + "href": "http://labadie.test/jacqueline", + "label": "Erchirion" + }, + { + "href": "http://dickinson.example/retha", + "label": "Lóni" + }, + { + "href": "http://reilly.test/jena_bailey", + "label": "Gothmog" + }, + { + "href": "http://cummings.test/moshe", + "label": "Donnamira Took" + }, + { + "href": "http://treutel.example/bess_blick", + "label": "Bregil" + } + ], + "remediation_available": false, + "rule_group_id": "85dc43d9-34e6-4cc9-b856-9a2a6ab5cd7c", + "severity": "high", + "title": "Voluptatum qui magni quos.", + "type": "rule", + "value_checks": null + }, + { + "description": "Saepe quibusdam dolorem. Laudantium occaecati ut. Maiores et quas.", + "id": "61ecb1bb-2f43-457c-9b13-9c1fb7f5a181", + "identifier": { + "href": "http://glover-ruecker.example/anton", + "label": "Angamaitë" + }, + "precedence": 6688, + "rationale": "Ut vel sunt. Ipsam nemo et. Molestias rerum voluptate.", + "ref_id": "xccdf_org.ssgproject.content_rule_2e1867a532b0f20f45943ed384941b7c", + "references": [ + { + "href": "http://rutherford.example/delila", + "label": "Lenwë" + }, + { + "href": "http://stamm-smith.test/katy.labadie", + "label": "Folcred" + }, + { + "href": "http://howe.example/norah", + "label": "Imrazôr" + }, + { + "href": "http://bartell-moore.example/sammy", + "label": "Nimrodel" + }, + { + "href": "http://kilback-kris.test/arnold.mraz", + "label": "Nurwë" + } + ], + "remediation_available": false, + "rule_group_id": "008351e5-3c16-4c55-84be-11c2961531a2", + "severity": "medium", + "title": "Quo dolore dignissimos et.", + "type": "rule", + "value_checks": null + }, + { + "description": "Eum laudantium cumque. Repudiandae enim similique. Voluptatum id explicabo.", + "id": "72ad8804-aa41-46af-9f6b-00012e09e616", + "identifier": { + "href": "http://grady.example/clinton", + "label": "Sagroth" + }, + "precedence": 3364, + "rationale": "Sed et a. Suscipit nemo ut. Quis natus dolor.", + "ref_id": "xccdf_org.ssgproject.content_rule_6265706dfc0b5f2ada73cfb31bead9a9", + "references": [ + { + "href": "http://corkery-osinski.example/zita.west", + "label": "Elentir" + }, + { + "href": "http://anderson.example/chung", + "label": "Dervorin" + }, + { + "href": "http://morar.test/kathryne.yundt", + "label": "Lúthien" + }, + { + "href": "http://kohler-bernier.example/keven", + "label": "Belen" + }, + { + "href": "http://wiza.test/francesco", + "label": "Elanor Gardner" + } + ], + "remediation_available": false, + "rule_group_id": "aab1db3b-4ae6-4373-a2bb-96c4d46e182f", + "severity": "medium", + "title": "Iure ipsa sapiente distinctio.", + "type": "rule", + "value_checks": null + }, + { + "description": "Possimus aut corporis. Rerum dolorem aut. Totam quasi qui.", + "id": "76f4c37d-0da3-4fbe-b693-cfaf9e722dcc", + "identifier": { + "href": "http://ziemann-stehr.test/gary", + "label": "Faniel" + }, + "precedence": 9660, + "rationale": "Fugit non dolorem. Debitis reiciendis et. Ut voluptatem laudantium.", + "ref_id": "xccdf_org.ssgproject.content_rule_1db0a9cfdf31e20e258cea106f53080e", + "references": [ + { + "href": "http://kulas.test/avery_stehr", + "label": "Ioreth" + }, + { + "href": "http://daugherty.example/rubin", + "label": "Dori" + }, + { + "href": "http://abbott-grant.test/cristen.gutmann", + "label": "Lalaith" + }, + { + "href": "http://emard.example/star.klocko", + "label": "Bard" + }, + { + "href": "http://beer-heidenreich.example/so_mosciski", + "label": "Daeron" + } + ], + "remediation_available": false, + "rule_group_id": "15cb3d3e-80b5-48a1-9e79-1d1eea6f42ae", + "severity": "medium", + "title": "Occaecati quaerat quis laborum.", + "type": "rule", + "value_checks": null + }, + { + "description": "Unde nihil beatae. Culpa quia consequatur. Ut asperiores qui.", + "id": "7826db2e-2d1f-49eb-b81a-405a3b27ab45", + "identifier": { + "href": "http://monahan.example/roxanne", + "label": "Boar of Everholt" + }, + "precedence": 5074, + "rationale": "Earum maxime ex. Consequatur consequuntur ut. Voluptatem ipsum labore.", + "ref_id": "xccdf_org.ssgproject.content_rule_d0f6167c35fa61e1481174dfe2e01240", + "references": [ + { + "href": "http://oconner.test/qiana.green", + "label": "Dáin Ironfoot" + }, + { + "href": "http://hand.example/isabella", + "label": "Glirhuin" + }, + { + "href": "http://satterfield.example/jennifer_harvey", + "label": "Baran" + }, + { + "href": "http://ondricka.example/isidra.greenfelder", + "label": "Nellas" + }, + { + "href": "http://jacobi.example/sherill", + "label": "Beleg" + } + ], + "remediation_available": false, + "rule_group_id": "b6448d8b-2607-46ac-811f-80ce9141f645", + "severity": "low", + "title": "Est occaecati minima cumque.", + "type": "rule", + "value_checks": null + } + ], + "links": { + "first": "/api/compliance/v2/policies/f6cbfaf9-23ae-47e2-b8e2-f682b4dcb5e2/tailorings/eb648bb2-d524-4496-8c46-99f5c784ecb8/rules?limit=10&offset=0", + "last": "/api/compliance/v2/policies/f6cbfaf9-23ae-47e2-b8e2-f682b4dcb5e2/tailorings/eb648bb2-d524-4496-8c46-99f5c784ecb8/rules?limit=10&offset=20", + "next": "/api/compliance/v2/policies/f6cbfaf9-23ae-47e2-b8e2-f682b4dcb5e2/tailorings/eb648bb2-d524-4496-8c46-99f5c784ecb8/rules?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/rule" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Assigns all specified rules and unassigns the rest" + } + }, + "summary": "Bulk assign Rules to a Tailoring", + "tags": [ + "Policies" + ] + } + }, + "/policies/{policy_id}/tailorings/{tailoring_id}/rules/{rule_id}": { + "delete": { + "description": "Use this to remove a rule from your tailoring.", + "operationId": "UnassignRule", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "tailoring_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "UUID or a ref_id with '.' characters replaced with '-'", + "in": "path", + "name": "rule_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "Unassigns a Rule from a Tailoring": { + "description": "", + "summary": "", + "value": { + "data": { + "description": "Sed cupiditate fugit. Laboriosam iure provident. Doloribus qui officiis.", + "id": "1a3bdb29-7294-42b2-b9dd-8adde6f06d34", + "identifier": { + "href": "http://stokes.example/hipolito.leuschke", + "label": "Enerdhil" + }, + "precedence": 5068, + "rationale": "Aut expedita voluptatum. Minus inventore non. Doloremque alias iste.", + "ref_id": "xccdf_org.ssgproject.content_rule_e175904fe73f5fceab8ac2cddde1400e", + "references": [ + { + "href": "http://sawayn.example/collette.willms", + "label": "Malbeth" + }, + { + "href": "http://streich-jones.test/gricelda", + "label": "Iago Grubb" + }, + { + "href": "http://schmitt.example/ervin", + "label": "Isilmo" + }, + { + "href": "http://pagac.test/bret", + "label": "Aranwë" + }, + { + "href": "http://oberbrunner-pfannerstill.test/bryon.runolfsson", + "label": "Blanco Bracegirdle" + } + ], + "remediation_available": false, + "rule_group_id": "77e0fd94-e58d-4d5c-abfe-2a0aba65ff28", + "severity": "medium", + "title": "Laborum numquam et dolores.", + "type": "rule", + "value_checks": null + } + } + } + } + } + }, + "description": "Unassigns a Rule from a Tailoring" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when unassigning a non-existing Rule": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Rule not found with ID e57d62e1-0044-4b72-9631-09981a286ac4" + ] + } + } + } + } + }, + "description": "Returns with Not found" + } + }, + "summary": "Unassign a Rule from a Tailoring", + "tags": [ + "Policies" + ] + }, + "patch": { + "description": "Add a rule to a specific tailoring.", + "operationId": "AssignRule", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "tailoring_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "UUID or a ref_id with '.' characters replaced with '-'", + "in": "path", + "name": "rule_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "Assigns a Rule to a Tailoring": { + "description": "", + "summary": "", + "value": { + "data": { + "description": "Quisquam consequatur odit. Ut ab suscipit. Fugit sint nobis.", + "id": "ba9f257f-a461-436e-ada9-3c482c835791", + "identifier": { + "href": "http://schmitt.example/adam.hilll", + "label": "Pervinca Took" + }, + "precedence": 2764, + "rationale": "Dolorem quia nesciunt. Veniam neque consequatur. Animi voluptate fuga.", + "ref_id": "xccdf_org.ssgproject.content_rule_2f2e6ebf53c5ccbb21a5f4b067f5ddfb", + "references": [ + { + "href": "http://lynch.test/dallas.ryan", + "label": "Estelmo" + }, + { + "href": "http://collins-fadel.example/wanita", + "label": "Muzgash" + }, + { + "href": "http://kreiger.test/teodoro_frami", + "label": "Angelica Baggins" + }, + { + "href": "http://williamson-lindgren.test/shawnna", + "label": "Gormadoc Brandybuck" + }, + { + "href": "http://jerde-morar.test/hank", + "label": "Aldor" + } + ], + "remediation_available": false, + "rule_group_id": "9db23c6d-6c42-4ad4-a8c5-9cd4d9567099", + "severity": "high", + "title": "Culpa ut aliquid earum.", + "type": "rule", + "value_checks": null + } + } + } + } + } + }, + "description": "Assigns a Rule to a Tailoring" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns with Not found": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Rule not found with ID 9a698fd4-d7b6-4c0f-9a8a-3577fb109eb8" + ] + } + } + } + } + }, + "description": "Returns with Not found" + } + }, + "summary": "Assign a Rule to a Tailoring", + "tags": [ + "Policies" + ] + } + }, + "/policies/{policy_id}/tailorings/{tailoring_id}/tailoring_file.json": { + "get": { + "description": "Retrieve a tailoring file of a specific tailoring.", + "operationId": "TailoringFile", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "UUID or OS minor version number", + "in": "path", + "name": "tailoring_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Tailoring File": { + "description": "", + "summary": "", + "value": { + "profiles": [ + { + "groups": {}, + "id": "xccdf_org.ssgproject.content_profile_3ef60d9b5f3e2ff14447e08eaab3d25b", + "rules": {}, + "title": "Ut quis dolorem quo.", + "variables": { + "foo_value_04828135-013c-43f0-aebd-ee19df3253d1": { + "value": "405716" + }, + "foo_value_dcc8625a-333e-45ef-be39-08ff6b0bd23a": { + "value": "146232" + } + } + } + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/tailoring_file" + } + } + }, + "description": "Returns a Tailoring File" + } + }, + "summary": "Request a Tailoring file", + "tags": [ + "Policies" + ] + } + }, + "/reports": { + "get": { + "description": "Retrieve a list of all available reports.", + "operationId": "Reports", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "os_major_version", + "business_objective", + "compliance_threshold", + "percent_compliant", + "title:asc", + "title:desc", + "os_major_version:asc", + "os_major_version:desc", + "business_objective:asc", + "business_objective:desc", + "compliance_threshold:asc", + "compliance_threshold:desc", + "percent_compliant:asc", + "percent_compliant:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Reports are searchable using attributes `title`, `os_major_version`, `with_reported_systems`, and `percent_compliant`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Reports": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "system", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Perspiciatis corrupti voluptatem. Enim exercitationem rem. Inventore omnis quia.", + "id": "41fcef69-a3cf-41c1-92d2-0894243d23b9", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Nam doloribus cum eaque.", + "ref_id": "xccdf_org.ssgproject.content_profile_10f9bea05bf164597d21e3a4750121b9", + "reported_system_count": 4, + "title": "Qui labore quod et.", + "type": "report", + "unsupported_system_count": 2 + }, + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "feed", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Quia quisquam in. Eaque et est. Quos aut omnis.", + "id": "693fd31c-913f-484b-82a4-41d95032ee6e", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Ea dolores vel facere.", + "ref_id": "xccdf_org.ssgproject.content_profile_c8242d35f3155d838cf54d319de72424", + "reported_system_count": 4, + "title": "Sit eligendi repellat neque.", + "type": "report", + "unsupported_system_count": 2 + }, + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "circuit", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Repellat neque laborum. Minus sit iure. Officia nostrum ipsam.", + "id": "bc23716e-19b2-4b5d-9576-cf7c2c6b58be", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Corrupti autem commodi molestias.", + "ref_id": "xccdf_org.ssgproject.content_profile_dd874033fe31d88ad515e012104bd333", + "reported_system_count": 4, + "title": "Qui quae doloremque cumque.", + "type": "report", + "unsupported_system_count": 2 + }, + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "monitor", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Recusandae deserunt molestiae. Voluptas deleniti qui. Similique sed dolorem.", + "id": "dd960254-7bdb-4d16-8bef-7cd430649362", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Similique quidem molestiae eaque.", + "ref_id": "xccdf_org.ssgproject.content_profile_dc968fd23a80e13edb1190438f29bafe", + "reported_system_count": 4, + "title": "Cupiditate corporis corrupti voluptate.", + "type": "report", + "unsupported_system_count": 2 + }, + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "card", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Eos rem soluta. Aperiam eum unde. Ea saepe enim.", + "id": "fbe777d0-a7c6-4cce-a0d4-a045e347a69e", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Impedit exercitationem amet dolores.", + "ref_id": "xccdf_org.ssgproject.content_profile_b0304c9872a9eebdbe8ae2df030f6ca9", + "reported_system_count": 4, + "title": "Aut enim esse voluptatum.", + "type": "report", + "unsupported_system_count": 2 + } + ], + "links": { + "first": "/api/compliance/v2/reports?limit=10&offset=0", + "last": "/api/compliance/v2/reports?limit=10&offset=0" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 5 + } + } + }, + "List of Reports sorted by \"os_major_version:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "alarm", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Aut id quia. Dolores sapiente inventore. Atque quibusdam et.", + "id": "469333a5-b633-47c1-8035-273f2194c990", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Molestiae accusamus labore veritatis.", + "ref_id": "xccdf_org.ssgproject.content_profile_cf178d29b092d42abf4b5aa881494a9d", + "reported_system_count": 4, + "title": "Velit pariatur quia nemo.", + "type": "report", + "unsupported_system_count": 2 + }, + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "card", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Veritatis ullam sed. Ipsum doloremque ut. Et veniam itaque.", + "id": "668a307d-c410-442c-874d-4b5e014fc1c0", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Inventore nihil fugiat et.", + "ref_id": "xccdf_org.ssgproject.content_profile_2750a53100d76f26f0f197c25f81d97b", + "reported_system_count": 4, + "title": "Sed minima dignissimos voluptate.", + "type": "report", + "unsupported_system_count": 2 + }, + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "bandwidth", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Voluptas reiciendis veritatis. Earum consequatur est. Dolor doloremque velit.", + "id": "d409d05b-5385-4846-bcaa-465fd272742c", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Pariatur quia cum officiis.", + "ref_id": "xccdf_org.ssgproject.content_profile_7b507483bd694e76d1c03a0fae0a3d83", + "reported_system_count": 4, + "title": "Vitae blanditiis fugiat sed.", + "type": "report", + "unsupported_system_count": 2 + }, + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "transmitter", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Quasi quae dignissimos. Aut in placeat. Aspernatur ea atque.", + "id": "e0915a19-331b-43b0-ac2a-66f201713874", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Quia vero dolorum earum.", + "ref_id": "xccdf_org.ssgproject.content_profile_30236198a4889b32cb5460af9a83aa75", + "reported_system_count": 4, + "title": "Eum ex corporis omnis.", + "type": "report", + "unsupported_system_count": 2 + }, + { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "system", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Non omnis hic. Harum dolorem et. Vero error ut.", + "id": "f6f152ed-e761-4560-83d2-f5e9a1df86c4", + "os_major_version": 8, + "percent_compliant": 25, + "profile_title": "Rem dolores et totam.", + "ref_id": "xccdf_org.ssgproject.content_profile_7bb3500ee3cb16a9d9030052ea7c2d7d", + "reported_system_count": 4, + "title": "Distinctio rerum sit nihil.", + "type": "report", + "unsupported_system_count": 2 + } + ], + "links": { + "first": "/api/compliance/v2/reports?limit=10&offset=0&sort_by=os_major_version", + "last": "/api/compliance/v2/reports?limit=10&offset=0&sort_by=os_major_version" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "os_major_version", + "total": 5 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Reports" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Reports", + "tags": [ + "Reports" + ] + } + }, + "/reports/os_versions": { + "get": { + "deprecated": true, + "description": "This feature is exclusively used by the frontend", + "operationId": "ReportsOS", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Reports are searchable using attributes `title`, `os_major_version`, `with_reported_systems`, and `percent_compliant`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of available OS versions": { + "description": "", + "summary": "", + "value": [] + } + }, + "schema": { + "items": { + "type": "integer" + }, + "type": "array" + } + } + }, + "description": "Lists available OS versions" + } + }, + "summary": "Request the list of available OS versions", + "tags": [ + "Reports" + ] + } + }, + "/reports/{report_id}": { + "delete": { + "description": "Delete test results for a specific report.", + "operationId": "DeleteReport", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "content": { + "application/vnd.api+json": { + "examples": { + "Deletes Report's test results": { + "description": "", + "summary": "", + "value": { + "data": { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "protocol", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Repudiandae numquam et. Ad numquam dolores. Voluptates eos illo.", + "id": "54da7f07-8a05-4744-add0-ac098f6b7901", + "os_major_version": 9, + "percent_compliant": 25, + "profile_title": "Aut est illum voluptates.", + "ref_id": "xccdf_org.ssgproject.content_profile_603a8565987329e7e0157da48a173c43", + "reported_system_count": 4, + "title": "Fugiat nostrum id animi.", + "type": "report", + "unsupported_system_count": 2 + } + } + } + } + } + }, + "description": "Deletes Report's test results" + } + }, + "summary": "Delete a Report results", + "tags": [ + "Reports" + ] + }, + "get": { + "description": "Retrieve a specific report.", + "operationId": "Report", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Report": { + "description": "", + "summary": "", + "value": { + "data": { + "all_systems_exposed": true, + "assigned_system_count": 4, + "business_objective": "transmitter", + "compliance_threshold": 90, + "compliant_system_count": 1, + "description": "Tenetur esse distinctio. Architecto natus praesentium. Facilis rerum consequatur.", + "id": "cc0350c8-05bc-4ce5-a287-9b0288b5bff6", + "os_major_version": 9, + "percent_compliant": 25, + "profile_title": "Officia similique mollitia non.", + "ref_id": "xccdf_org.ssgproject.content_profile_b2adac603216554b00678daf09344fd9", + "reported_system_count": 4, + "title": "Molestias consequatur magnam aliquid.", + "type": "report", + "unsupported_system_count": 2 + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/report" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Report" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Report": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Report not found with ID 1284c9b7-01cf-4338-82b1-6c439b228f5d" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Report", + "tags": [ + "Reports" + ] + } + }, + "/reports/{report_id}/stats": { + "get": { + "deprecated": true, + "description": "Returns detailed stats for a Report", + "operationId": "ReportStats", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns detailed stats for a Report": { + "description": "", + "summary": "", + "value": { + "top_failed_rules": [] + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/report_stats" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns detailed stats for a Report" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Report": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Report not found with ID 02f38533-3148-4dc3-a5fd-72152bde07ad" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request detailed stats for a Report", + "tags": [ + "Reports" + ] + } + }, + "/reports/{report_id}/systems": { + "get": { + "description": "Retrieve all of the systems for a specific report.", + "operationId": "ReportSystems", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "An array of tags to narrow down the search results. In case the value contains symbols used for separators (`/` or `=`), they need to be encoded.
e.g.: `namespace/key=value`, `insights-client/selinux-config=SELINUX%3Denforcing`", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "display_name", + "os_minor_version", + "os_version", + "groups", + "display_name:asc", + "display_name:desc", + "os_minor_version:asc", + "os_minor_version:desc", + "os_version:asc", + "os_version:desc", + "groups:asc", + "groups:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_minor_version`, `never_reported`, and `group_name`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Systems": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:09.478Z", + "display_name": "hirthe.test", + "groups": [], + "id": "096d854b-982a-432d-a24a-5cff42b956ee", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.478Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.478Z", + "tags": [ + { + "key": "panel", + "namespace": "overriding", + "value": "1080p" + }, + { + "key": "protocol", + "namespace": "quantifying", + "value": "mobile" + }, + { + "key": "alarm", + "namespace": "calculating", + "value": "primary" + }, + { + "key": "port", + "namespace": "backing up", + "value": "virtual" + }, + { + "key": "panel", + "namespace": "backing up", + "value": "auxiliary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.478Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.431Z", + "display_name": "block-heidenreich.test", + "groups": [], + "id": "0ba6e3bd-0dfc-4919-a355-d9bf118cddcd", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.431Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.431Z", + "tags": [ + { + "key": "microchip", + "namespace": "quantifying", + "value": "back-end" + }, + { + "key": "application", + "namespace": "generating", + "value": "solid state" + }, + { + "key": "feed", + "namespace": "parsing", + "value": "cross-platform" + }, + { + "key": "bandwidth", + "namespace": "navigating", + "value": "primary" + }, + { + "key": "port", + "namespace": "bypassing", + "value": "auxiliary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.431Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.407Z", + "display_name": "mcglynn.test", + "groups": [], + "id": "13a038ff-aecf-4b6a-8f4c-a3f7849d33b1", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.407Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.407Z", + "tags": [ + { + "key": "matrix", + "namespace": "transmitting", + "value": "open-source" + }, + { + "key": "card", + "namespace": "calculating", + "value": "bluetooth" + }, + { + "key": "bandwidth", + "namespace": "overriding", + "value": "wireless" + }, + { + "key": "matrix", + "namespace": "overriding", + "value": "auxiliary" + }, + { + "key": "protocol", + "namespace": "hacking", + "value": "auxiliary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.407Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.396Z", + "display_name": "hoppe.test", + "groups": [], + "id": "31826589-a557-47fa-a680-f8d9df92211b", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.396Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.396Z", + "tags": [ + { + "key": "sensor", + "namespace": "overriding", + "value": "online" + }, + { + "key": "system", + "namespace": "indexing", + "value": "1080p" + }, + { + "key": "panel", + "namespace": "synthesizing", + "value": "bluetooth" + }, + { + "key": "hard drive", + "namespace": "bypassing", + "value": "wireless" + }, + { + "key": "transmitter", + "namespace": "quantifying", + "value": "1080p" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.396Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.460Z", + "display_name": "bode.test", + "groups": [], + "id": "3a77c6ce-a7dc-4a63-b654-07fbce88e52d", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.460Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.460Z", + "tags": [ + { + "key": "interface", + "namespace": "generating", + "value": "virtual" + }, + { + "key": "array", + "namespace": "programming", + "value": "solid state" + }, + { + "key": "bus", + "namespace": "navigating", + "value": "mobile" + }, + { + "key": "driver", + "namespace": "transmitting", + "value": "multi-byte" + }, + { + "key": "driver", + "namespace": "synthesizing", + "value": "mobile" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.460Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.412Z", + "display_name": "berge.test", + "groups": [], + "id": "470e53cd-2ed4-4a85-a4f0-21de25ed736f", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.412Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.412Z", + "tags": [ + { + "key": "program", + "namespace": "synthesizing", + "value": "mobile" + }, + { + "key": "interface", + "namespace": "navigating", + "value": "wireless" + }, + { + "key": "capacitor", + "namespace": "generating", + "value": "optical" + }, + { + "key": "capacitor", + "namespace": "quantifying", + "value": "neural" + }, + { + "key": "driver", + "namespace": "connecting", + "value": "multi-byte" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.412Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.520Z", + "display_name": "corkery.example", + "groups": [], + "id": "58e2c86a-f725-45cc-b7c0-cf197d701dcd", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.520Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.520Z", + "tags": [ + { + "key": "card", + "namespace": "quantifying", + "value": "wireless" + }, + { + "key": "driver", + "namespace": "compressing", + "value": "virtual" + }, + { + "key": "circuit", + "namespace": "parsing", + "value": "open-source" + }, + { + "key": "capacitor", + "namespace": "programming", + "value": "primary" + }, + { + "key": "transmitter", + "namespace": "quantifying", + "value": "haptic" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.520Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.499Z", + "display_name": "lang.example", + "groups": [], + "id": "5b5c5138-fa2b-43d3-b4c5-cce4abb7aaca", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.499Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.499Z", + "tags": [ + { + "key": "bus", + "namespace": "programming", + "value": "virtual" + }, + { + "key": "pixel", + "namespace": "connecting", + "value": "primary" + }, + { + "key": "panel", + "namespace": "calculating", + "value": "virtual" + }, + { + "key": "interface", + "namespace": "indexing", + "value": "neural" + }, + { + "key": "matrix", + "namespace": "indexing", + "value": "back-end" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.499Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.426Z", + "display_name": "denesik.example", + "groups": [], + "id": "5bff40c5-0771-46d5-8c36-b54f00593963", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.426Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.426Z", + "tags": [ + { + "key": "driver", + "namespace": "navigating", + "value": "wireless" + }, + { + "key": "alarm", + "namespace": "synthesizing", + "value": "wireless" + }, + { + "key": "interface", + "namespace": "generating", + "value": "redundant" + }, + { + "key": "microchip", + "namespace": "compressing", + "value": "bluetooth" + }, + { + "key": "monitor", + "namespace": "transmitting", + "value": "multi-byte" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.426Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.525Z", + "display_name": "glover-sanford.example", + "groups": [], + "id": "5ff276fc-f901-4b9d-b68c-483b03c0277b", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "c6712af8-9707-4036-8242-adab3e58f4ec", + "title": "Excepturi rem sed et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.525Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.525Z", + "tags": [ + { + "key": "program", + "namespace": "overriding", + "value": "primary" + }, + { + "key": "capacitor", + "namespace": "generating", + "value": "optical" + }, + { + "key": "protocol", + "namespace": "backing up", + "value": "wireless" + }, + { + "key": "application", + "namespace": "backing up", + "value": "neural" + }, + { + "key": "driver", + "namespace": "quantifying", + "value": "back-end" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.525Z" + } + ], + "links": { + "first": "/api/compliance/v2/reports/c6712af8-9707-4036-8242-adab3e58f4ec/systems?limit=10&offset=0", + "last": "/api/compliance/v2/reports/c6712af8-9707-4036-8242-adab3e58f4ec/systems?limit=10&offset=20", + "next": "/api/compliance/v2/reports/c6712af8-9707-4036-8242-adab3e58f4ec/systems?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "tags": [], + "total": 25 + } + } + }, + "List of Systems filtered by \"(os_minor_version=0)\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:10.140Z", + "display_name": "jakubowski.example", + "groups": [], + "id": "0e03f58e-d3a1-4c82-b63f-8925b8d35591", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.140Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.140Z", + "tags": [ + { + "key": "port", + "namespace": "programming", + "value": "digital" + }, + { + "key": "transmitter", + "namespace": "navigating", + "value": "online" + }, + { + "key": "feed", + "namespace": "copying", + "value": "wireless" + }, + { + "key": "bus", + "namespace": "calculating", + "value": "online" + }, + { + "key": "port", + "namespace": "transmitting", + "value": "redundant" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.140Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:10.190Z", + "display_name": "pacocha.example", + "groups": [], + "id": "125f3ec3-c124-4ea3-87bb-48d3be95af55", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.190Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.190Z", + "tags": [ + { + "key": "transmitter", + "namespace": "transmitting", + "value": "wireless" + }, + { + "key": "capacitor", + "namespace": "connecting", + "value": "cross-platform" + }, + { + "key": "bandwidth", + "namespace": "backing up", + "value": "mobile" + }, + { + "key": "array", + "namespace": "parsing", + "value": "auxiliary" + }, + { + "key": "port", + "namespace": "synthesizing", + "value": "digital" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.190Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:10.103Z", + "display_name": "kling.example", + "groups": [], + "id": "134d9516-76c5-42fb-bf98-44bb9647c761", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.103Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.103Z", + "tags": [ + { + "key": "application", + "namespace": "copying", + "value": "virtual" + }, + { + "key": "bandwidth", + "namespace": "navigating", + "value": "online" + }, + { + "key": "panel", + "namespace": "parsing", + "value": "bluetooth" + }, + { + "key": "program", + "namespace": "synthesizing", + "value": "digital" + }, + { + "key": "application", + "namespace": "compressing", + "value": "wireless" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.103Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:10.178Z", + "display_name": "armstrong-gusikowski.example", + "groups": [], + "id": "160ed158-d158-4ac0-bd57-d4b5add69dbb", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.178Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.178Z", + "tags": [ + { + "key": "program", + "namespace": "hacking", + "value": "virtual" + }, + { + "key": "monitor", + "namespace": "connecting", + "value": "1080p" + }, + { + "key": "port", + "namespace": "generating", + "value": "cross-platform" + }, + { + "key": "microchip", + "namespace": "transmitting", + "value": "back-end" + }, + { + "key": "matrix", + "namespace": "quantifying", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.178Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:10.205Z", + "display_name": "ratke.example", + "groups": [], + "id": "2093a57f-6a51-436e-90f1-2a36011e0f6e", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.205Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.205Z", + "tags": [ + { + "key": "feed", + "namespace": "overriding", + "value": "cross-platform" + }, + { + "key": "pixel", + "namespace": "compressing", + "value": "neural" + }, + { + "key": "alarm", + "namespace": "quantifying", + "value": "primary" + }, + { + "key": "card", + "namespace": "backing up", + "value": "neural" + }, + { + "key": "array", + "namespace": "parsing", + "value": "open-source" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.205Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:10.113Z", + "display_name": "king-ondricka.test", + "groups": [], + "id": "25e1ae6a-08cf-4ea4-bace-141f78fef090", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.113Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.113Z", + "tags": [ + { + "key": "application", + "namespace": "bypassing", + "value": "back-end" + }, + { + "key": "interface", + "namespace": "calculating", + "value": "1080p" + }, + { + "key": "feed", + "namespace": "programming", + "value": "wireless" + }, + { + "key": "alarm", + "namespace": "hacking", + "value": "multi-byte" + }, + { + "key": "protocol", + "namespace": "parsing", + "value": "cross-platform" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.113Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:10.249Z", + "display_name": "okeefe.test", + "groups": [], + "id": "2ac6f939-4be5-483b-a99d-02912efb02c9", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.249Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.249Z", + "tags": [ + { + "key": "hard drive", + "namespace": "parsing", + "value": "cross-platform" + }, + { + "key": "system", + "namespace": "programming", + "value": "haptic" + }, + { + "key": "card", + "namespace": "backing up", + "value": "optical" + }, + { + "key": "bandwidth", + "namespace": "quantifying", + "value": "redundant" + }, + { + "key": "panel", + "namespace": "connecting", + "value": "wireless" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.249Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:10.244Z", + "display_name": "tillman-sporer.example", + "groups": [], + "id": "2bd9e065-70b2-4503-99dc-5394c5bca3bd", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.244Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.244Z", + "tags": [ + { + "key": "monitor", + "namespace": "backing up", + "value": "neural" + }, + { + "key": "interface", + "namespace": "compressing", + "value": "wireless" + }, + { + "key": "transmitter", + "namespace": "backing up", + "value": "cross-platform" + }, + { + "key": "bus", + "namespace": "overriding", + "value": "back-end" + }, + { + "key": "system", + "namespace": "backing up", + "value": "cross-platform" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.244Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:10.225Z", + "display_name": "hammes.test", + "groups": [], + "id": "374e6319-15e1-49c6-813b-a59562c6eab7", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.225Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.225Z", + "tags": [ + { + "key": "protocol", + "namespace": "transmitting", + "value": "haptic" + }, + { + "key": "bus", + "namespace": "copying", + "value": "bluetooth" + }, + { + "key": "system", + "namespace": "programming", + "value": "online" + }, + { + "key": "system", + "namespace": "synthesizing", + "value": "open-source" + }, + { + "key": "system", + "namespace": "compressing", + "value": "solid state" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.225Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:10.119Z", + "display_name": "bahringer.test", + "groups": [], + "id": "3e2fa67e-73e3-41f6-88e0-85617055ac95", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "ad88dd46-2e61-49de-b3f0-48ca26f5e2bb", + "title": "Quibusdam aut ut facere." + } + ], + "stale_timestamp": "2034-11-23T09:30:10.119Z", + "stale_warning_timestamp": "2034-11-30T09:30:10.119Z", + "tags": [ + { + "key": "driver", + "namespace": "quantifying", + "value": "back-end" + }, + { + "key": "sensor", + "namespace": "calculating", + "value": "redundant" + }, + { + "key": "firewall", + "namespace": "indexing", + "value": "mobile" + }, + { + "key": "protocol", + "namespace": "connecting", + "value": "multi-byte" + }, + { + "key": "alarm", + "namespace": "navigating", + "value": "digital" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:10.119Z" + } + ], + "links": { + "first": "/api/compliance/v2/reports/ad88dd46-2e61-49de-b3f0-48ca26f5e2bb/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", + "last": "/api/compliance/v2/reports/ad88dd46-2e61-49de-b3f0-48ca26f5e2bb/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", + "next": "/api/compliance/v2/reports/ad88dd46-2e61-49de-b3f0-48ca26f5e2bb/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=10" + }, + "meta": { + "filter": "(os_minor_version=0)", + "limit": 10, + "offset": 0, + "tags": [], + "total": 25 + } + } + }, + "List of Systems sorted by \"os_minor_version:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:09.868Z", + "display_name": "bogan.example", + "groups": [], + "id": "00b6ed52-0069-4137-a562-0e2cc978591c", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.868Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.868Z", + "tags": [ + { + "key": "program", + "namespace": "copying", + "value": "virtual" + }, + { + "key": "microchip", + "namespace": "copying", + "value": "neural" + }, + { + "key": "port", + "namespace": "backing up", + "value": "1080p" + }, + { + "key": "program", + "namespace": "bypassing", + "value": "back-end" + }, + { + "key": "firewall", + "namespace": "hacking", + "value": "online" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.868Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.812Z", + "display_name": "reilly.example", + "groups": [], + "id": "09dc7cb8-f91f-41db-a572-82abe57652c1", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.812Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.812Z", + "tags": [ + { + "key": "firewall", + "namespace": "navigating", + "value": "haptic" + }, + { + "key": "bandwidth", + "namespace": "calculating", + "value": "neural" + }, + { + "key": "transmitter", + "namespace": "copying", + "value": "1080p" + }, + { + "key": "system", + "namespace": "backing up", + "value": "digital" + }, + { + "key": "transmitter", + "namespace": "hacking", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.812Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.836Z", + "display_name": "weimann.test", + "groups": [], + "id": "2b4a6b25-3076-4f0e-9915-7e1dc10fec47", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.836Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.836Z", + "tags": [ + { + "key": "card", + "namespace": "indexing", + "value": "cross-platform" + }, + { + "key": "system", + "namespace": "copying", + "value": "auxiliary" + }, + { + "key": "protocol", + "namespace": "navigating", + "value": "solid state" + }, + { + "key": "matrix", + "namespace": "connecting", + "value": "virtual" + }, + { + "key": "monitor", + "namespace": "backing up", + "value": "wireless" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.836Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.771Z", + "display_name": "erdman.test", + "groups": [], + "id": "3e877517-ab2c-464b-8dbe-2b1dde4f94dc", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.771Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.771Z", + "tags": [ + { + "key": "alarm", + "namespace": "quantifying", + "value": "solid state" + }, + { + "key": "matrix", + "namespace": "transmitting", + "value": "digital" + }, + { + "key": "pixel", + "namespace": "quantifying", + "value": "back-end" + }, + { + "key": "card", + "namespace": "copying", + "value": "multi-byte" + }, + { + "key": "microchip", + "namespace": "indexing", + "value": "open-source" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.771Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.807Z", + "display_name": "emard.test", + "groups": [], + "id": "4a9619d7-67a9-44dc-a606-7bde18a355cc", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.807Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.807Z", + "tags": [ + { + "key": "interface", + "namespace": "transmitting", + "value": "digital" + }, + { + "key": "interface", + "namespace": "hacking", + "value": "open-source" + }, + { + "key": "feed", + "namespace": "connecting", + "value": "mobile" + }, + { + "key": "transmitter", + "namespace": "parsing", + "value": "online" + }, + { + "key": "program", + "namespace": "synthesizing", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.807Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.852Z", + "display_name": "ferry-ziemann.example", + "groups": [], + "id": "4d7262ed-4e8e-42fe-9b4f-b50db73afff1", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.852Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.852Z", + "tags": [ + { + "key": "driver", + "namespace": "hacking", + "value": "auxiliary" + }, + { + "key": "application", + "namespace": "quantifying", + "value": "auxiliary" + }, + { + "key": "microchip", + "namespace": "backing up", + "value": "online" + }, + { + "key": "port", + "namespace": "synthesizing", + "value": "1080p" + }, + { + "key": "panel", + "namespace": "connecting", + "value": "1080p" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.852Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.820Z", + "display_name": "oconner.example", + "groups": [], + "id": "5995781c-1c5b-4253-850f-b2286c240f4d", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.820Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.820Z", + "tags": [ + { + "key": "program", + "namespace": "backing up", + "value": "virtual" + }, + { + "key": "panel", + "namespace": "programming", + "value": "back-end" + }, + { + "key": "application", + "namespace": "synthesizing", + "value": "primary" + }, + { + "key": "microchip", + "namespace": "generating", + "value": "bluetooth" + }, + { + "key": "transmitter", + "namespace": "navigating", + "value": "multi-byte" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.820Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.802Z", + "display_name": "littel.test", + "groups": [], + "id": "5b7f6975-d75a-46c2-b3eb-0d7eedd21fbb", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.802Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.802Z", + "tags": [ + { + "key": "system", + "namespace": "bypassing", + "value": "bluetooth" + }, + { + "key": "array", + "namespace": "programming", + "value": "open-source" + }, + { + "key": "driver", + "namespace": "generating", + "value": "redundant" + }, + { + "key": "bus", + "namespace": "bypassing", + "value": "cross-platform" + }, + { + "key": "monitor", + "namespace": "backing up", + "value": "neural" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.802Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.781Z", + "display_name": "wilkinson.example", + "groups": [], + "id": "6250b19b-ec87-4f72-8a47-c42dcdc77148", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.781Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.781Z", + "tags": [ + { + "key": "panel", + "namespace": "navigating", + "value": "optical" + }, + { + "key": "circuit", + "namespace": "connecting", + "value": "haptic" + }, + { + "key": "system", + "namespace": "compressing", + "value": "bluetooth" + }, + { + "key": "driver", + "namespace": "calculating", + "value": "cross-platform" + }, + { + "key": "array", + "namespace": "overriding", + "value": "solid state" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.781Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:09.760Z", + "display_name": "rutherford.example", + "groups": [], + "id": "6372f602-02e7-43b8-9c47-82bf72d3d485", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9", + "title": "Voluptas quo et et." + } + ], + "stale_timestamp": "2034-11-23T09:30:09.760Z", + "stale_warning_timestamp": "2034-11-30T09:30:09.760Z", + "tags": [ + { + "key": "application", + "namespace": "navigating", + "value": "solid state" + }, + { + "key": "alarm", + "namespace": "transmitting", + "value": "virtual" + }, + { + "key": "hard drive", + "namespace": "synthesizing", + "value": "auxiliary" + }, + { + "key": "feed", + "namespace": "copying", + "value": "bluetooth" + }, + { + "key": "alarm", + "namespace": "connecting", + "value": "optical" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:09.760Z" + } + ], + "links": { + "first": "/api/compliance/v2/reports/6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9/systems?limit=10&offset=0&sort_by=os_minor_version", + "last": "/api/compliance/v2/reports/6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9/systems?limit=10&offset=20&sort_by=os_minor_version", + "next": "/api/compliance/v2/reports/6195cb2e-e9d2-432a-84ef-0d1a06bbe6b9/systems?limit=10&offset=10&sort_by=os_minor_version" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "os_minor_version", + "tags": [], + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/system" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Systems assigned to a Report" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Systems assigned to a Report", + "tags": [ + "Reports" + ] + } + }, + "/reports/{report_id}/systems/os_versions": { + "get": { + "deprecated": true, + "description": "This feature is exclusively used by the frontend", + "operationId": "ReportSystemsOS", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_version`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `never_reported`, `group_name`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of available OS versions": { + "description": "", + "summary": "", + "value": [ + "8.0" + ] + } + }, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "description": "Lists available OS versions" + } + }, + "summary": "Request the list of available OS versions", + "tags": [ + "Systems" + ] + } + }, + "/reports/{report_id}/systems/{system_id}": { + "get": { + "description": "Retrieve a specific system from a specific report.", + "operationId": "ReportSystem", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "system_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a System under a Report": { + "description": "", + "summary": "", + "value": { + "data": { + "culled_timestamp": "2034-12-07T09:30:11.531Z", + "display_name": "weimann-stroman.test", + "groups": [], + "id": "5d183edd-f32c-4e64-846e-95e666d5b724", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [ + { + "id": "460d0879-f0ef-462f-a4b2-ee7d975d6c6f", + "title": "Voluptatum voluptatem veritatis cupiditate." + } + ], + "stale_timestamp": "2034-11-23T09:30:11.531Z", + "stale_warning_timestamp": "2034-11-30T09:30:11.531Z", + "tags": [ + { + "key": "sensor", + "namespace": "navigating", + "value": "primary" + }, + { + "key": "capacitor", + "namespace": "parsing", + "value": "auxiliary" + }, + { + "key": "driver", + "namespace": "parsing", + "value": "wireless" + }, + { + "key": "matrix", + "namespace": "transmitting", + "value": "open-source" + }, + { + "key": "pixel", + "namespace": "indexing", + "value": "bluetooth" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:11.531Z" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/system" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a System under a Report" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing System": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::System not found with ID ae13ba2c-39ec-49ac-b80f-824e7ac93dfb" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a System", + "tags": [ + "Reports" + ] + } + }, + "/reports/{report_id}/test_results": { + "get": { + "description": "Retrieve all of the test results for a specific report.", + "operationId": "ReportTestResults", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "An array of tags to narrow down the search results. In case the value contains symbols used for separators (`/` or `=`), they need to be encoded.
e.g.: `namespace/key=value`, `insights-client/selinux-config=SELINUX%3Denforcing`", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "display_name", + "security_guide_version", + "groups", + "score", + "end_time", + "failed_rule_count", + "display_name:asc", + "display_name:desc", + "security_guide_version:asc", + "security_guide_version:desc", + "groups:asc", + "groups:desc", + "score:asc", + "score:desc", + "end_time:asc", + "end_time:desc", + "failed_rule_count:asc", + "failed_rule_count:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Test Results are searchable using attributes `score`, `supported`, `system_id`, `display_name`, `os_minor_version`, `security_guide_version`, `compliant`, `group_name`, and `failed_rule_severity`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Test Results": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "compliant": false, + "display_name": "koss.example", + "end_time": "2024-11-23T09:29:13.471Z", + "failed_rule_count": 0, + "groups": [], + "id": "056dcc55-fc43-4f5d-88d9-85312d6e2db1", + "os_major_version": 8, + "os_minor_version": 0, + "score": 63.38656323684226, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "76fb0776-657f-43b0-b91a-0fdb295acda9", + "tags": [ + { + "key": "matrix", + "namespace": "navigating", + "value": "auxiliary" + }, + { + "key": "program", + "namespace": "synthesizing", + "value": "cross-platform" + }, + { + "key": "panel", + "namespace": "bypassing", + "value": "digital" + }, + { + "key": "circuit", + "namespace": "quantifying", + "value": "wireless" + }, + { + "key": "hard drive", + "namespace": "connecting", + "value": "digital" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "heidenreich-bechtelar.test", + "end_time": "2024-11-23T09:29:13.476Z", + "failed_rule_count": 0, + "groups": [], + "id": "24deee50-0551-43bb-bdeb-5ac7df118510", + "os_major_version": 8, + "os_minor_version": 0, + "score": 50.89076594183962, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "41bc2faa-07f7-43d2-9a14-3b4ec1d23ee9", + "tags": [ + { + "key": "monitor", + "namespace": "transmitting", + "value": "optical" + }, + { + "key": "capacitor", + "namespace": "generating", + "value": "auxiliary" + }, + { + "key": "port", + "namespace": "generating", + "value": "online" + }, + { + "key": "program", + "namespace": "navigating", + "value": "solid state" + }, + { + "key": "capacitor", + "namespace": "compressing", + "value": "multi-byte" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "wolff.test", + "end_time": "2024-11-23T09:29:13.608Z", + "failed_rule_count": 0, + "groups": [], + "id": "3520cdf1-8a99-4330-aa87-bb4ec21ee433", + "os_major_version": 8, + "os_minor_version": 0, + "score": 75.96307955214992, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "2c52ef9f-a19d-4b2f-b10d-fd1f97ecb401", + "tags": [ + { + "key": "pixel", + "namespace": "copying", + "value": "virtual" + }, + { + "key": "microchip", + "namespace": "programming", + "value": "solid state" + }, + { + "key": "application", + "namespace": "indexing", + "value": "neural" + }, + { + "key": "alarm", + "namespace": "backing up", + "value": "auxiliary" + }, + { + "key": "feed", + "namespace": "calculating", + "value": "multi-byte" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "kunde.test", + "end_time": "2024-11-23T09:29:13.544Z", + "failed_rule_count": 0, + "groups": [], + "id": "37f25749-9428-407e-b545-61d377e376ff", + "os_major_version": 8, + "os_minor_version": 0, + "score": 56.01902024349224, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "6d939a6a-18fa-4a83-9391-924ff7d0008a", + "tags": [ + { + "key": "pixel", + "namespace": "generating", + "value": "solid state" + }, + { + "key": "interface", + "namespace": "navigating", + "value": "open-source" + }, + { + "key": "application", + "namespace": "compressing", + "value": "optical" + }, + { + "key": "driver", + "namespace": "hacking", + "value": "primary" + }, + { + "key": "pixel", + "namespace": "quantifying", + "value": "redundant" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "tromp.test", + "end_time": "2024-11-23T09:29:13.494Z", + "failed_rule_count": 0, + "groups": [], + "id": "39c959f7-6033-4ac4-bfa6-1dcc29e5c287", + "os_major_version": 8, + "os_minor_version": 0, + "score": 42.29670226418916, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "fce2d362-d3a7-4652-805b-7d31a4d8fece", + "tags": [ + { + "key": "transmitter", + "namespace": "synthesizing", + "value": "virtual" + }, + { + "key": "application", + "namespace": "bypassing", + "value": "online" + }, + { + "key": "card", + "namespace": "parsing", + "value": "multi-byte" + }, + { + "key": "feed", + "namespace": "compressing", + "value": "back-end" + }, + { + "key": "matrix", + "namespace": "parsing", + "value": "online" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "cremin-pollich.example", + "end_time": "2024-11-23T09:29:13.507Z", + "failed_rule_count": 0, + "groups": [], + "id": "46baf15d-32d5-4a05-a5de-a221f1c5cc70", + "os_major_version": 8, + "os_minor_version": 0, + "score": 70.20547946561567, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "4f1461ed-a66f-4888-9133-6fa90e769d47", + "tags": [ + { + "key": "protocol", + "namespace": "bypassing", + "value": "digital" + }, + { + "key": "protocol", + "namespace": "indexing", + "value": "wireless" + }, + { + "key": "matrix", + "namespace": "overriding", + "value": "virtual" + }, + { + "key": "array", + "namespace": "connecting", + "value": "primary" + }, + { + "key": "application", + "namespace": "connecting", + "value": "open-source" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "hoeger.test", + "end_time": "2024-11-23T09:29:13.576Z", + "failed_rule_count": 0, + "groups": [], + "id": "49eac2cf-4f9d-4a54-a9ab-4f848d6becbd", + "os_major_version": 8, + "os_minor_version": 0, + "score": 11.92583487962368, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "136c0b55-8c42-4cca-b405-f55e32ed1316", + "tags": [ + { + "key": "feed", + "namespace": "backing up", + "value": "digital" + }, + { + "key": "microchip", + "namespace": "indexing", + "value": "haptic" + }, + { + "key": "hard drive", + "namespace": "parsing", + "value": "back-end" + }, + { + "key": "card", + "namespace": "compressing", + "value": "1080p" + }, + { + "key": "capacitor", + "namespace": "calculating", + "value": "digital" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "bayer-cruickshank.test", + "end_time": "2024-11-23T09:29:13.570Z", + "failed_rule_count": 0, + "groups": [], + "id": "6257c2ee-5232-4932-b98a-0bc9824fe1ec", + "os_major_version": 8, + "os_minor_version": 0, + "score": 57.5815230941054, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "17d82d56-0c82-416a-abcd-811eabd587c4", + "tags": [ + { + "key": "protocol", + "namespace": "generating", + "value": "auxiliary" + }, + { + "key": "matrix", + "namespace": "compressing", + "value": "back-end" + }, + { + "key": "alarm", + "namespace": "indexing", + "value": "digital" + }, + { + "key": "sensor", + "namespace": "hacking", + "value": "optical" + }, + { + "key": "application", + "namespace": "copying", + "value": "online" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "schmidt.test", + "end_time": "2024-11-23T09:29:13.482Z", + "failed_rule_count": 0, + "groups": [], + "id": "627b34cb-d52d-4936-8f26-0f32881f21c5", + "os_major_version": 8, + "os_minor_version": 0, + "score": 28.60286633233848, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "9fcd948f-b67d-46d1-89d6-dca78e177b2a", + "tags": [ + { + "key": "bandwidth", + "namespace": "calculating", + "value": "primary" + }, + { + "key": "microchip", + "namespace": "overriding", + "value": "multi-byte" + }, + { + "key": "bandwidth", + "namespace": "overriding", + "value": "multi-byte" + }, + { + "key": "system", + "namespace": "backing up", + "value": "wireless" + }, + { + "key": "transmitter", + "namespace": "overriding", + "value": "1080p" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "hoppe-king.example", + "end_time": "2024-11-23T09:29:13.589Z", + "failed_rule_count": 0, + "groups": [], + "id": "717ba712-f991-4340-872e-1db7699c9b9d", + "os_major_version": 8, + "os_minor_version": 0, + "score": 4.715833120124535, + "security_guide_version": "100.100.23", + "supported": true, + "system_id": "660d9e54-6c7f-432f-baa9-a6f16ad181d5", + "tags": [ + { + "key": "port", + "namespace": "hacking", + "value": "digital" + }, + { + "key": "microchip", + "namespace": "overriding", + "value": "mobile" + }, + { + "key": "program", + "namespace": "connecting", + "value": "wireless" + }, + { + "key": "monitor", + "namespace": "compressing", + "value": "mobile" + }, + { + "key": "hard drive", + "namespace": "synthesizing", + "value": "back-end" + } + ], + "type": "test_result" + } + ], + "links": { + "first": "/api/compliance/v2/reports/98b123cb-a64b-4850-b947-40d43658a90d/test_results?limit=10&offset=0", + "last": "/api/compliance/v2/reports/98b123cb-a64b-4850-b947-40d43658a90d/test_results?limit=10&offset=20", + "next": "/api/compliance/v2/reports/98b123cb-a64b-4850-b947-40d43658a90d/test_results?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "tags": [], + "total": 25 + } + } + }, + "List of Test Results filtered by \"(os_minor_version=8)\"": { + "description": "", + "summary": "", + "value": { + "data": [], + "links": { + "first": "/api/compliance/v2/reports/1cd3a25b-469e-4f67-b703-2f5b38441b72/test_results?filter=%28os_minor_version%3D8%29&limit=10&offset=0", + "last": "/api/compliance/v2/reports/1cd3a25b-469e-4f67-b703-2f5b38441b72/test_results?filter=%28os_minor_version%3D8%29&limit=10&offset=0" + }, + "meta": { + "filter": "(os_minor_version=8)", + "limit": 10, + "offset": 0, + "tags": [], + "total": 0 + } + } + }, + "List of Test Results sorted by \"score:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "compliant": false, + "display_name": "murphy.example", + "end_time": "2024-11-23T09:29:13.989Z", + "failed_rule_count": 0, + "groups": [], + "id": "f63feb03-8348-446a-a9c2-25b286ee0217", + "os_major_version": 8, + "os_minor_version": 0, + "score": 12.42807800105265, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "18523e7e-56c5-43fb-a901-be6c1e846958", + "tags": [ + { + "key": "card", + "namespace": "hacking", + "value": "cross-platform" + }, + { + "key": "application", + "namespace": "parsing", + "value": "digital" + }, + { + "key": "protocol", + "namespace": "overriding", + "value": "mobile" + }, + { + "key": "capacitor", + "namespace": "synthesizing", + "value": "solid state" + }, + { + "key": "microchip", + "namespace": "overriding", + "value": "1080p" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "sporer.example", + "end_time": "2024-11-23T09:29:13.995Z", + "failed_rule_count": 0, + "groups": [], + "id": "a085c374-867d-416e-a0ce-e6d5a5ae8138", + "os_major_version": 8, + "os_minor_version": 0, + "score": 16.777458265505, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "8cf4ebb8-8394-41c8-bfc7-f3adf16554c2", + "tags": [ + { + "key": "system", + "namespace": "bypassing", + "value": "haptic" + }, + { + "key": "panel", + "namespace": "backing up", + "value": "online" + }, + { + "key": "sensor", + "namespace": "backing up", + "value": "optical" + }, + { + "key": "transmitter", + "namespace": "calculating", + "value": "1080p" + }, + { + "key": "microchip", + "namespace": "transmitting", + "value": "wireless" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "lynch.example", + "end_time": "2024-11-23T09:29:13.889Z", + "failed_rule_count": 0, + "groups": [], + "id": "ad7a36f6-0651-406b-8fd2-2d05abed6d96", + "os_major_version": 8, + "os_minor_version": 0, + "score": 23.684712022929, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "8a88890d-e770-4fb5-b266-b65006885e7c", + "tags": [ + { + "key": "capacitor", + "namespace": "copying", + "value": "bluetooth" + }, + { + "key": "feed", + "namespace": "bypassing", + "value": "bluetooth" + }, + { + "key": "array", + "namespace": "bypassing", + "value": "multi-byte" + }, + { + "key": "firewall", + "namespace": "overriding", + "value": "virtual" + }, + { + "key": "firewall", + "namespace": "quantifying", + "value": "back-end" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "lemke.example", + "end_time": "2024-11-23T09:29:13.972Z", + "failed_rule_count": 0, + "groups": [], + "id": "0273fbbe-8212-44b7-aedb-e8f6b8a9764a", + "os_major_version": 8, + "os_minor_version": 0, + "score": 26.04523395370187, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "66ac55b9-3987-40fe-a7b0-567f2a2e803b", + "tags": [ + { + "key": "matrix", + "namespace": "parsing", + "value": "mobile" + }, + { + "key": "interface", + "namespace": "parsing", + "value": "solid state" + }, + { + "key": "array", + "namespace": "programming", + "value": "1080p" + }, + { + "key": "system", + "namespace": "calculating", + "value": "virtual" + }, + { + "key": "interface", + "namespace": "indexing", + "value": "primary" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "hartmann.example", + "end_time": "2024-11-23T09:29:13.954Z", + "failed_rule_count": 0, + "groups": [], + "id": "181e66f7-8eab-4124-8aff-41605fed4445", + "os_major_version": 8, + "os_minor_version": 0, + "score": 36.68994556658671, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "8e90858d-b7eb-4ebf-be2a-c8318a57ca51", + "tags": [ + { + "key": "circuit", + "namespace": "connecting", + "value": "cross-platform" + }, + { + "key": "panel", + "namespace": "synthesizing", + "value": "haptic" + }, + { + "key": "bandwidth", + "namespace": "hacking", + "value": "solid state" + }, + { + "key": "sensor", + "namespace": "navigating", + "value": "open-source" + }, + { + "key": "system", + "namespace": "backing up", + "value": "auxiliary" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "crooks.example", + "end_time": "2024-11-23T09:29:13.901Z", + "failed_rule_count": 0, + "groups": [], + "id": "2c3aa043-5e1e-4249-9bd0-057dbc0edba5", + "os_major_version": 8, + "os_minor_version": 0, + "score": 38.90242262261728, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "c5643bce-bca4-4e25-aa07-f164e7ac4ec2", + "tags": [ + { + "key": "panel", + "namespace": "synthesizing", + "value": "bluetooth" + }, + { + "key": "alarm", + "namespace": "transmitting", + "value": "optical" + }, + { + "key": "sensor", + "namespace": "hacking", + "value": "primary" + }, + { + "key": "sensor", + "namespace": "backing up", + "value": "multi-byte" + }, + { + "key": "interface", + "namespace": "connecting", + "value": "optical" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "rodriguez-gulgowski.test", + "end_time": "2024-11-23T09:29:13.931Z", + "failed_rule_count": 0, + "groups": [], + "id": "93939589-9339-4473-a65b-c7a0ddad7c18", + "os_major_version": 8, + "os_minor_version": 0, + "score": 41.06830190615271, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "99ab16d8-0da5-4df6-bad5-b56000ba4932", + "tags": [ + { + "key": "capacitor", + "namespace": "synthesizing", + "value": "auxiliary" + }, + { + "key": "hard drive", + "namespace": "navigating", + "value": "wireless" + }, + { + "key": "circuit", + "namespace": "navigating", + "value": "bluetooth" + }, + { + "key": "system", + "namespace": "backing up", + "value": "primary" + }, + { + "key": "circuit", + "namespace": "programming", + "value": "back-end" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "bednar-harber.test", + "end_time": "2024-11-23T09:29:13.914Z", + "failed_rule_count": 0, + "groups": [], + "id": "8183e5e0-9060-444d-8168-061b5745c092", + "os_major_version": 8, + "os_minor_version": 0, + "score": 44.58820890076775, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "93b8a3e8-c7d5-41dd-94e5-7d091a7d2583", + "tags": [ + { + "key": "matrix", + "namespace": "connecting", + "value": "optical" + }, + { + "key": "interface", + "namespace": "synthesizing", + "value": "multi-byte" + }, + { + "key": "capacitor", + "namespace": "transmitting", + "value": "virtual" + }, + { + "key": "circuit", + "namespace": "bypassing", + "value": "virtual" + }, + { + "key": "port", + "namespace": "generating", + "value": "auxiliary" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "marks.example", + "end_time": "2024-11-23T09:29:13.977Z", + "failed_rule_count": 0, + "groups": [], + "id": "27f90cc7-14b5-4bbd-b2cf-2be0f45c86ae", + "os_major_version": 8, + "os_minor_version": 0, + "score": 44.79751689283131, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "23c36f20-2c9b-4ecb-a3ba-82c7ed8864dd", + "tags": [ + { + "key": "circuit", + "namespace": "parsing", + "value": "open-source" + }, + { + "key": "port", + "namespace": "quantifying", + "value": "primary" + }, + { + "key": "bus", + "namespace": "overriding", + "value": "solid state" + }, + { + "key": "microchip", + "namespace": "backing up", + "value": "open-source" + }, + { + "key": "program", + "namespace": "backing up", + "value": "multi-byte" + } + ], + "type": "test_result" + }, + { + "compliant": false, + "display_name": "rice-gislason.example", + "end_time": "2024-11-23T09:29:13.877Z", + "failed_rule_count": 0, + "groups": [], + "id": "4fade579-4125-403f-81b8-20c86993efba", + "os_major_version": 8, + "os_minor_version": 0, + "score": 46.00489454546969, + "security_guide_version": "100.101.40", + "supported": true, + "system_id": "cd6aec4c-6fdf-442e-b024-60a3d3545157", + "tags": [ + { + "key": "circuit", + "namespace": "overriding", + "value": "mobile" + }, + { + "key": "matrix", + "namespace": "calculating", + "value": "solid state" + }, + { + "key": "card", + "namespace": "backing up", + "value": "wireless" + }, + { + "key": "capacitor", + "namespace": "overriding", + "value": "virtual" + }, + { + "key": "monitor", + "namespace": "generating", + "value": "open-source" + } + ], + "type": "test_result" + } + ], + "links": { + "first": "/api/compliance/v2/reports/c3d7f4b2-db2d-4646-b49f-473053956f43/test_results?limit=10&offset=0&sort_by=score", + "last": "/api/compliance/v2/reports/c3d7f4b2-db2d-4646-b49f-473053956f43/test_results?limit=10&offset=20&sort_by=score", + "next": "/api/compliance/v2/reports/c3d7f4b2-db2d-4646-b49f-473053956f43/test_results?limit=10&offset=10&sort_by=score" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "score", + "tags": [], + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/test_result" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Test Results under a Report" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Test Results under a Report", + "tags": [ + "Reports" + ] + } + }, + "/reports/{report_id}/test_results/os_versions": { + "get": { + "deprecated": true, + "description": "This feature is exclusively used by the frontend", + "operationId": "ReportTestResultsOS", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Test Results are searchable using attributes `score`, `supported`, `system_id`, `display_name`, `os_minor_version`, `security_guide_version`, `compliant`, `group_name`, and `failed_rule_severity`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of available OS versions": { + "description": "", + "summary": "", + "value": [ + "8.0" + ] + } + }, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "description": "Lists available OS versions" + } + }, + "summary": "Request the list of available OS versions", + "tags": [ + "Reports" + ] + } + }, + "/reports/{report_id}/test_results/security_guide_versions": { + "get": { + "deprecated": true, + "description": "This feature is exclusively used by the frontend", + "operationId": "ReportTestResultsSG", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of available Security Guide versions": { + "description": "", + "summary": "", + "value": [ + "100.107.39" + ] + } + }, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "description": "Lists available Security Guide versions" + } + }, + "summary": "Request the list of available Security Guide versions", + "tags": [ + "Reports" + ] + } + }, + "/reports/{report_id}/test_results/{test_result_id}": { + "get": { + "description": "Retrieve a specific test result for a specific report.", + "operationId": "ReportTestResult", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "test_result_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Test Result under a Report": { + "description": "", + "summary": "", + "value": { + "data": { + "compliant": true, + "display_name": "rutherford.example", + "end_time": "2024-11-23T09:29:16.147Z", + "failed_rule_count": 0, + "groups": [], + "id": "5674063f-8bb2-4453-b04b-f0732d60be33", + "os_major_version": 8, + "os_minor_version": 0, + "score": 97.76381952384386, + "security_guide_version": "100.109.16", + "supported": true, + "system_id": "75b0119e-fa3b-4f0d-8909-51778bd9c4a6", + "tags": [ + { + "key": "array", + "namespace": "overriding", + "value": "1080p" + }, + { + "key": "driver", + "namespace": "indexing", + "value": "multi-byte" + }, + { + "key": "transmitter", + "namespace": "generating", + "value": "primary" + }, + { + "key": "microchip", + "namespace": "synthesizing", + "value": "multi-byte" + }, + { + "key": "application", + "namespace": "hacking", + "value": "wireless" + } + ], + "type": "test_result" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/system" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Test Result under a Report" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Test Result": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::TestResult not found with ID a579c721-9b43-4647-9f9d-c39086e3a386" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Test Result", + "tags": [ + "Reports" + ] + } + }, + "/reports/{report_id}/test_results/{test_result_id}/rule_results": { + "get": { + "description": "Retrieve all of the rule results for a specific report.", + "operationId": "ReportRuleResults", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "result", + "severity", + "title", + "precedence", + "remediation_available", + "result:asc", + "result:desc", + "severity:asc", + "severity:desc", + "title:asc", + "title:desc", + "precedence:asc", + "precedence:desc", + "remediation_available:asc", + "remediation_available:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rule Results are searchable using attributes `result`, `title`, `severity`, `remediation_available`, and `rule_group_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "test_result_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "report_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Rule Results": { + "description": "", + "summary": "", + "value": { + "data": [], + "links": { + "first": "/api/compliance/v2/reports/67f135f8-856b-401d-8ff5-6ae342050998/test_results/16b8265c-f6a2-432f-aa38-134827f0ff7c/rule_results?limit=10&offset=0", + "last": "/api/compliance/v2/reports/67f135f8-856b-401d-8ff5-6ae342050998/test_results/16b8265c-f6a2-432f-aa38-134827f0ff7c/rule_results?limit=10&offset=0" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 0 + } + } + }, + "List of Rule Results filtered by \"(title=foo)\"": { + "description": "", + "summary": "", + "value": { + "data": [], + "links": { + "first": "/api/compliance/v2/reports/41d0df66-b6e6-4ff8-939b-f77b02f8c999/test_results/815f6488-3ddd-40fd-af1a-c58de621f21d/rule_results?filter=%28title%3Dfoo%29&limit=10&offset=0", + "last": "/api/compliance/v2/reports/41d0df66-b6e6-4ff8-939b-f77b02f8c999/test_results/815f6488-3ddd-40fd-af1a-c58de621f21d/rule_results?filter=%28title%3Dfoo%29&limit=10&offset=0" + }, + "meta": { + "filter": "(title=foo)", + "limit": 10, + "offset": 0, + "total": 0 + } + } + }, + "List of Rule Results sorted by \"result:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [], + "links": { + "first": "/api/compliance/v2/reports/f5dd334f-378d-4860-a1d4-b37486fda402/test_results/3cfb1b25-ed59-4f28-9886-90d7574a299e/rule_results?limit=10&offset=0&sort_by=result", + "last": "/api/compliance/v2/reports/f5dd334f-378d-4860-a1d4-b37486fda402/test_results/3cfb1b25-ed59-4f28-9886-90d7574a299e/rule_results?limit=10&offset=0&sort_by=result" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "result", + "total": 0 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/rule_result" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Rule Results under a Report" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Rule Results under a Report", + "tags": [ + "Reports" + ] + } + }, + "/security_guides": { + "get": { + "description": "Retrieve a list of all SCAP security guides.", + "operationId": "SecurityGuides", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "version", + "os_major_version", + "title:asc", + "title:desc", + "version:asc", + "version:desc", + "os_major_version:asc", + "os_major_version:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Security Guides are searchable using attributes `title`, `version`, `ref_id`, `os_major_version`, `profile_ref_id`, and `supported_profile`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Security Guides": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Omnis quo deleniti. Id ut nemo. Omnis et facere.", + "id": "0a79038a-7e09-49cf-9664-065c47367c7e", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Perferendis quo sunt alias.", + "type": "security_guide", + "version": "100.81.35" + }, + { + "description": "Ratione non distinctio. Repellendus pariatur accusantium. Perspiciatis neque laboriosam.", + "id": "0ec21680-1166-4ca1-8cb0-09af88e5efc5", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Et voluptas saepe alias.", + "type": "security_guide", + "version": "100.81.31" + }, + { + "description": "Aut necessitatibus nihil. Autem qui magni. At illum qui.", + "id": "3537335b-9100-4ff8-9014-b30b4604b733", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Consequatur dolorum et accusamus.", + "type": "security_guide", + "version": "100.81.25" + }, + { + "description": "Cum quis tenetur. Quae qui aspernatur. Tenetur possimus repellendus.", + "id": "433adc74-7284-4d42-a598-25aea59e44ae", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Qui ut perspiciatis non.", + "type": "security_guide", + "version": "100.81.43" + }, + { + "description": "Minus quas quisquam. Voluptatibus quisquam laborum. Tempora assumenda nostrum.", + "id": "4b27fb6a-838d-4995-8f2d-518fc7ea584b", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Et quas dolorum blanditiis.", + "type": "security_guide", + "version": "100.81.30" + }, + { + "description": "Quia iste quas. Est voluptatibus pariatur. Et in voluptate.", + "id": "4fa02f5d-9d4d-441f-95d6-fbc3b8541be0", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Occaecati hic repellat aliquam.", + "type": "security_guide", + "version": "100.81.38" + }, + { + "description": "Vero facilis voluptatem. Quasi iusto voluptate. Vel nobis consequatur.", + "id": "54638ca3-5136-44d9-b0b0-63a96eac3622", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Et esse molestias molestiae.", + "type": "security_guide", + "version": "100.81.24" + }, + { + "description": "Perferendis aut sint. Praesentium est dolore. Et quod sint.", + "id": "5b95f20c-a224-461b-aaa3-0dc35a5d5d9a", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Assumenda quia aliquid reprehenderit.", + "type": "security_guide", + "version": "100.81.45" + }, + { + "description": "Dolores rerum libero. Est quasi optio. Mollitia vitae quia.", + "id": "5c3f6b45-115f-405c-b4c2-71a12e81fbd5", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "In dolore vitae et.", + "type": "security_guide", + "version": "100.81.26" + }, + { + "description": "Earum aut a. Ut nesciunt minus. Ut et omnis.", + "id": "5e862dba-b1e2-4c20-a73d-3ea2e9f77bb1", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Ab magnam omnis quas.", + "type": "security_guide", + "version": "100.81.42" + } + ], + "links": { + "first": "/api/compliance/v2/security_guides?limit=10&offset=0", + "last": "/api/compliance/v2/security_guides?limit=10&offset=20", + "next": "/api/compliance/v2/security_guides?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + }, + "List of Security Guides filtered by \"(os_major_version=8)\"": { + "description": "", + "summary": "", + "value": { + "data": [], + "links": { + "first": "/api/compliance/v2/security_guides?filter=%28os_major_version%3D8%29&limit=10&offset=0", + "last": "/api/compliance/v2/security_guides?filter=%28os_major_version%3D8%29&limit=10&offset=0" + }, + "meta": { + "filter": "(os_major_version=8)", + "limit": 10, + "offset": 0, + "total": 0 + } + } + }, + "List of Security Guides sorted by \"os_major_version:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Qui iure quam. Odio modi optio. Amet ex enim.", + "id": "04a0b4fd-52b3-4537-8ec9-09829974f23e", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Dolor provident at atque.", + "type": "security_guide", + "version": "100.82.21" + }, + { + "description": "Reprehenderit dolor eum. Id tempora sunt. Autem neque sapiente.", + "id": "0bea205a-3abb-4abd-bcfd-9f95ae05db1c", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Corporis ut numquam architecto.", + "type": "security_guide", + "version": "100.82.10" + }, + { + "description": "Dolore omnis quod. Natus cum numquam. Omnis eligendi cum.", + "id": "1017e893-a2dd-4e57-8ae8-15f589d91c9d", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Ratione sed id et.", + "type": "security_guide", + "version": "100.82.2" + }, + { + "description": "Minima eius aut. Sunt excepturi culpa. Quia quidem excepturi.", + "id": "135bf44a-7bd3-4dc2-850b-efc42dd43450", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Accusamus natus nulla sed.", + "type": "security_guide", + "version": "100.82.1" + }, + { + "description": "Iste sit incidunt. Provident beatae ratione. Atque aut sit.", + "id": "145b7713-8a4c-4925-a2ef-f02798080609", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Minima praesentium rerum delectus.", + "type": "security_guide", + "version": "100.82.12" + }, + { + "description": "Voluptatem molestias quas. Voluptas voluptatem sapiente. Perspiciatis perferendis voluptas.", + "id": "2c1f726c-72cf-4893-9bf4-850d3748c14d", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Temporibus laudantium sed dolorem.", + "type": "security_guide", + "version": "100.82.18" + }, + { + "description": "Corrupti doloremque dolorem. Est laudantium sint. Eos nobis autem.", + "id": "405770e9-de62-46ca-8024-717c9ad2232f", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Voluptas consequatur porro id.", + "type": "security_guide", + "version": "100.82.15" + }, + { + "description": "Aspernatur consequatur quis. Ratione officiis fugiat. Nihil magnam sapiente.", + "id": "45c0c084-eb42-4b98-be2c-f9c3f62f3d95", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Quia consequatur est voluptas.", + "type": "security_guide", + "version": "100.82.22" + }, + { + "description": "Fugit voluptatem incidunt. Sit maxime provident. Quia perspiciatis nobis.", + "id": "52ed814b-8104-4f82-883e-351f2f63ffe6", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Est sint nostrum quis.", + "type": "security_guide", + "version": "100.82.8" + }, + { + "description": "Totam consequuntur ipsam. Aut quibusdam laudantium. Sed dolores sit.", + "id": "595a757e-5343-4dfc-9a27-81303efeeec0", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Dolorem ullam fugit maiores.", + "type": "security_guide", + "version": "100.82.19" + } + ], + "links": { + "first": "/api/compliance/v2/security_guides?limit=10&offset=0&sort_by=os_major_version", + "last": "/api/compliance/v2/security_guides?limit=10&offset=20&sort_by=os_major_version", + "next": "/api/compliance/v2/security_guides?limit=10&offset=10&sort_by=os_major_version" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "os_major_version", + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/security_guide" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Security Guides" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Security Guides", + "tags": [ + "Content" + ] + } + }, + "/security_guides/os_versions": { + "get": { + "deprecated": true, + "description": "This feature is exclusively used by the frontend", + "operationId": "SecurityGuidesOS", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_version`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `never_reported`, `group_name`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of available OS versions": { + "description": "", + "summary": "", + "value": [ + 7 + ] + } + }, + "schema": { + "items": { + "type": "integer" + }, + "type": "array" + } + } + }, + "description": "Lists available OS versions" + } + }, + "summary": "Request the list of available OS versions", + "tags": [ + "Content" + ] + } + }, + "/security_guides/supported_profiles": { + "get": { + "description": "Retrieve the list of profiles supported by particular RHEL versions.", + "operationId": "SupportedProfiles", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "os_major_version", + "os_minor_versions", + "title:asc", + "title:desc", + "os_major_version:asc", + "os_major_version:desc", + "os_minor_versions:asc", + "os_minor_versions:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Supported Profiles are searchable using attributes `os_major_version`, `title`, and `ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Supported Profiles": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Voluptatum illo quo. Sit qui ut. Rem sed quia.", + "id": "d1a365bd-67c3-4d80-8b51-392a9c5d6c56", + "os_major_version": 7, + "os_minor_versions": [ + 3, + 2, + 1 + ], + "ref_id": "xccdf_org.ssgproject.content_profile_2449f265188e3bebb620fa0bd0852f58", + "security_guide_id": "928a116d-691e-40ff-939d-181192e43be1", + "security_guide_version": "100.85.10", + "title": "Perferendis sint id sed.", + "type": "supported_profile" + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/supported_profiles?limit=10&offset=0", + "last": "/api/compliance/v2/security_guides/supported_profiles?limit=10&offset=0" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 1 + } + } + }, + "List of Supported Profiles filtered by \"(os_major_version=8)\"": { + "description": "", + "summary": "", + "value": { + "data": [], + "links": { + "first": "/api/compliance/v2/security_guides/supported_profiles?filter=%28os_major_version%3D8%29&limit=10&offset=0", + "last": "/api/compliance/v2/security_guides/supported_profiles?filter=%28os_major_version%3D8%29&limit=10&offset=0" + }, + "meta": { + "filter": "(os_major_version=8)", + "limit": 10, + "offset": 0, + "total": 0 + } + } + }, + "List of Supported Profiles sorted by \"os_major_version:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Adipisci distinctio maiores. Magnam vel dolore. Sequi repudiandae enim.", + "id": "4a8bfdc1-c835-4b16-81c8-6f6422c9f417", + "os_major_version": 7, + "os_minor_versions": [ + 3, + 2, + 1 + ], + "ref_id": "xccdf_org.ssgproject.content_profile_6d03a31a93b2c5515732df7815d595c5", + "security_guide_id": "256b4d41-42e1-423a-802f-de61637b09c4", + "security_guide_version": "100.85.11", + "title": "Qui quam autem velit.", + "type": "supported_profile" + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/supported_profiles?limit=10&offset=0&sort_by=os_major_version", + "last": "/api/compliance/v2/security_guides/supported_profiles?limit=10&offset=0&sort_by=os_major_version" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "os_major_version", + "total": 1 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/supported_profile" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Supported Profiles" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Supported Profiles", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}": { + "get": { + "description": "Retrieve a specific security guide.", + "operationId": "SecurityGuide", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Security Guide": { + "description": "", + "summary": "", + "value": { + "data": { + "description": "Libero optio necessitatibus. Dolorem ex incidunt. Reiciendis et qui.", + "id": "d0b0d118-6682-4d8a-b43b-1b92daf74005", + "os_major_version": 7, + "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", + "title": "Culpa magnam aspernatur est.", + "type": "security_guide", + "version": "100.84.23" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/security_guide" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Security Guide" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Security Guide": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::SecurityGuide not found with ID ebddede9-9ca1-4dc1-a2ac-78f0663cb574" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Security Guide", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/profiles": { + "get": { + "description": "List all security guide profiles.", + "operationId": "Profiles", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "title:asc", + "title:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Profiles are searchable using attributes `title` and `ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Profiles": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Harum et qui. Magnam minima ipsa. Impedit vero repellendus.", + "id": "019c7981-81b8-403e-9e0e-859965fadea2", + "ref_id": "xccdf_org.ssgproject.content_profile_e035a8d9c715f3251f10986e95164b2f", + "title": "Et aut omnis aperiam.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Omnis sit quo. Ea delectus beatae. Ut quod accusantium.", + "id": "0ff6ca92-068a-4125-8044-73a34c064d2a", + "ref_id": "xccdf_org.ssgproject.content_profile_d01ea498b9e61b3fcafb7b188807c402", + "title": "Dolorem ratione pariatur molestias.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Aliquid eum expedita. Quae tempore laudantium. Facere eum laborum.", + "id": "12f1cbb2-715a-4d24-8be4-046a6d2fb41b", + "ref_id": "xccdf_org.ssgproject.content_profile_235303c3bdba8741f9d7a9349cb032a8", + "title": "Laboriosam libero ut consequatur.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Eos eius rerum. Qui nihil fugiat. Dolor qui et.", + "id": "17d796db-a724-4720-aef7-a1e5ec79341d", + "ref_id": "xccdf_org.ssgproject.content_profile_fc2cb8ea63a44e56c0722e5f80711f23", + "title": "Quo at ipsam voluptas.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Doloribus dolorem rem. Est nemo in. Rerum aut laudantium.", + "id": "1dde70bb-1503-4df5-a639-189ccb105c18", + "ref_id": "xccdf_org.ssgproject.content_profile_b059689225b805ac539c810f015ce031", + "title": "Odio atque vero doloribus.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Illum harum quos. Tenetur fuga eum. Officia sit aut.", + "id": "20b773cd-57e1-4747-9e92-f92c0c3e57b8", + "ref_id": "xccdf_org.ssgproject.content_profile_7617f6bd00da2cd441cbb31c8de1d922", + "title": "Est voluptas quos iusto.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Iste et odio. Aut rerum corrupti. Harum consequatur sequi.", + "id": "234f1a8c-6a4f-47cf-a262-4979ba9736c8", + "ref_id": "xccdf_org.ssgproject.content_profile_298c4698d780bdb60e1ff142d2527fd4", + "title": "Accusamus odio reprehenderit ut.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Aut id rerum. Quia ut aut. Nihil debitis voluptatem.", + "id": "2ce1a3c3-d1b1-4439-a23f-0da1d4f65cff", + "ref_id": "xccdf_org.ssgproject.content_profile_c0a557d05702fc59fd8b136b744bb752", + "title": "Totam ipsam sint eos.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Ipsum praesentium earum. Delectus tempore animi. Qui adipisci sit.", + "id": "35b32c42-bd44-4309-aa7d-1ddfb9d585af", + "ref_id": "xccdf_org.ssgproject.content_profile_4460a27fcf038367238c1f32fdbb9f49", + "title": "Distinctio ratione assumenda laborum.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Eum maiores ullam. Quas consequuntur vel. Omnis qui architecto.", + "id": "470630d3-1f08-471e-9be2-27747eb3248a", + "ref_id": "xccdf_org.ssgproject.content_profile_d27a1fbf7ac08ff79b15d0cfe3b2a13e", + "title": "Provident totam autem voluptas.", + "type": "profile", + "value_overrides": {} + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/17569f64-b16c-4888-969c-e4bd7e1ed385/profiles?limit=10&offset=0", + "last": "/api/compliance/v2/security_guides/17569f64-b16c-4888-969c-e4bd7e1ed385/profiles?limit=10&offset=20", + "next": "/api/compliance/v2/security_guides/17569f64-b16c-4888-969c-e4bd7e1ed385/profiles?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + }, + "List of Profiles filtered by '(title=Deleniti incidunt aspernatur ab.)'": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Mollitia possimus et. Doloremque corrupti deleniti. Voluptatibus ut assumenda.", + "id": "195de4fc-f982-48ec-bf54-062108b8529f", + "ref_id": "xccdf_org.ssgproject.content_profile_45c54089f0553714109bf44ccc060d81", + "title": "Deleniti incidunt aspernatur ab.", + "type": "profile", + "value_overrides": {} + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/98075212-ea21-4431-841a-b5a79f192e1e/profiles?filter=%28title%3D%22Deleniti+incidunt+aspernatur+ab.%22%29&limit=10&offset=0", + "last": "/api/compliance/v2/security_guides/98075212-ea21-4431-841a-b5a79f192e1e/profiles?filter=%28title%3D%22Deleniti+incidunt+aspernatur+ab.%22%29&limit=10&offset=0" + }, + "meta": { + "filter": "(title=\"Deleniti incidunt aspernatur ab.\")", + "limit": 10, + "offset": 0, + "total": 1 + } + } + }, + "List of Profiles sorted by \"title:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Sunt est blanditiis. Quidem omnis atque. Iure porro explicabo.", + "id": "f8e66f90-0320-4eea-a4b5-94259bbca4a0", + "ref_id": "xccdf_org.ssgproject.content_profile_be2fbb64f1df8064885a9e60ab768d00", + "title": "Animi explicabo et ipsam.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Laudantium iste totam. Fugiat repellat dolores. Officiis consequatur et.", + "id": "e450d4f5-2876-48ae-b992-100a8d39bfc8", + "ref_id": "xccdf_org.ssgproject.content_profile_9f4ed88a76aafb580db2fc748a730b2d", + "title": "Atque iste quia beatae.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Ea iusto et. Qui quasi laudantium. Earum deleniti sint.", + "id": "acd2feb0-bdaa-42a3-a48b-d0773fa519a1", + "ref_id": "xccdf_org.ssgproject.content_profile_71e38eca713d1f2bee6822e3837e69b7", + "title": "Autem voluptatem sapiente odit.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Totam veniam vel. Sit possimus iusto. Cupiditate ut saepe.", + "id": "09cb7439-eeb4-4886-88c8-c0acc1114345", + "ref_id": "xccdf_org.ssgproject.content_profile_60c58852e1246e92bf3ab8d07d5b2c38", + "title": "Cumque inventore adipisci qui.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Maxime perspiciatis veritatis. Non sit sequi. Velit ea aut.", + "id": "6d8f872b-5d5a-49db-80ca-2638adf35f92", + "ref_id": "xccdf_org.ssgproject.content_profile_b1d093fb6c1eb7f08ae690d3e0505e49", + "title": "Debitis voluptates et quia.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Explicabo quia voluptas. Fugit laboriosam modi. Magnam aliquid tempore.", + "id": "16e68bc2-f256-4b09-9b6a-63a033899b09", + "ref_id": "xccdf_org.ssgproject.content_profile_33d5a763e680ff65f2dd009096f1cdaa", + "title": "Dicta facilis et blanditiis.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Non enim facilis. Molestias eos sequi. Rerum eos ut.", + "id": "d6beb172-48cc-44ea-bb96-089b0fd55d6b", + "ref_id": "xccdf_org.ssgproject.content_profile_d8f068ce2aa7c56f902d0bb6a99adffc", + "title": "Et ut similique est.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Id provident exercitationem. Voluptates aliquam atque. Eius ut velit.", + "id": "9d203dcc-b116-4121-b3ee-5ba09b193c40", + "ref_id": "xccdf_org.ssgproject.content_profile_0fec2e36ea7e02c8dd9af6a7f9dcc20e", + "title": "Eveniet asperiores minus consequatur.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Quibusdam et beatae. Voluptas perferendis et. Ipsa ut iure.", + "id": "9c5ccbd5-1761-4554-b049-f732af9f222b", + "ref_id": "xccdf_org.ssgproject.content_profile_ae2807717a68a1d205c5705dc3842a77", + "title": "Fugit est sint fugiat.", + "type": "profile", + "value_overrides": {} + }, + { + "description": "Blanditiis ut consequatur. Quibusdam ullam et. Eos cupiditate excepturi.", + "id": "d4e7711c-1226-48a2-8d08-672ae2244223", + "ref_id": "xccdf_org.ssgproject.content_profile_5357cd54796aa1744c75caf22bfccb43", + "title": "Magni ut rerum et.", + "type": "profile", + "value_overrides": {} + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/23c476f0-2074-4a91-8c18-42700db478e1/profiles?limit=10&offset=0&sort_by=title", + "last": "/api/compliance/v2/security_guides/23c476f0-2074-4a91-8c18-42700db478e1/profiles?limit=10&offset=20&sort_by=title", + "next": "/api/compliance/v2/security_guides/23c476f0-2074-4a91-8c18-42700db478e1/profiles?limit=10&offset=10&sort_by=title" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "title", + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/profile" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Profiles" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Profiles", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/profiles/{profile_id}": { + "get": { + "description": "Retrieve a specific profile.", + "operationId": "Profile", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "UUID or a ref_id with '.' characters replaced with '-'", + "in": "path", + "name": "profile_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Profile": { + "description": "", + "summary": "", + "value": { + "data": { + "description": "Cum dolores cumque. Quis corrupti sit. Sed quo voluptatum.", + "id": "edb8199c-b2eb-4d67-ae13-9ee6f9ad7eb7", + "ref_id": "xccdf_org.ssgproject.content_profile_f1b83b83378431bbd572e6a8c0564021", + "title": "Rerum excepturi sint temporibus.", + "type": "profile", + "value_overrides": {} + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/profile" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Profile" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Profile": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Profile not found with ID 76f4d2a3-a116-4567-a02b-4e07a12ca773" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Profile", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/profiles/{profile_id}/rule_tree": { + "get": { + "deprecated": true, + "description": "Returns the Rule Tree of a Profile", + "operationId": "ProfileTree", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "profile_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns the Rule Tree of a Profile": { + "description": "", + "summary": "", + "value": [ + { + "children": [ + { + "id": "ac31dece-1eee-4725-8976-fe8ac5e5096f", + "type": "rule" + } + ], + "id": "d3a461d5-8df3-45f3-b19a-658777bfba87", + "type": "rule_group" + }, + { + "children": [ + { + "id": "9db5a9c0-1ae2-44c8-a6d0-12cfcb262d0a", + "type": "rule" + } + ], + "id": "2001c851-2360-4c03-bc6d-fc536e186552", + "type": "rule_group" + }, + { + "children": [ + { + "id": "0cfbbab4-f189-41f0-92ea-30d4d6b42081", + "type": "rule" + } + ], + "id": "397537bb-7eae-4ec7-84b6-4fb2f9e502b4", + "type": "rule_group" + }, + { + "children": [ + { + "id": "d881964e-e7d4-4808-85cf-34c7936e74bc", + "type": "rule" + } + ], + "id": "2cfc00b9-6bea-4e22-b069-5c60a2ebce6f", + "type": "rule_group" + }, + { + "children": [ + { + "id": "3c35a66d-77ee-44fd-b3da-cc52aac1e3f1", + "type": "rule" + } + ], + "id": "e3e675c5-80d4-45c9-a0ec-2eea38dff802", + "type": "rule_group" + }, + { + "children": [ + { + "id": "95eac319-b117-4d71-9376-802c293f02bf", + "type": "rule" + } + ], + "id": "350e1cc7-a022-4572-82b4-723cd9f64a23", + "type": "rule_group" + }, + { + "children": [ + { + "id": "7b263340-7f65-4c78-b2e1-1ee1447322a1", + "type": "rule" + } + ], + "id": "b447df33-6f73-4649-a9ef-9e9630d312a8", + "type": "rule_group" + }, + { + "children": [ + { + "id": "2d46af23-8496-4cf0-8687-a15582074d34", + "type": "rule" + } + ], + "id": "3c8d58a9-3663-48ad-9330-e5af71fa5ea2", + "type": "rule_group" + }, + { + "children": [ + { + "id": "8c1ad16a-1960-40d7-a876-839ed95474ce", + "type": "rule" + } + ], + "id": "54f070f9-adaa-4239-b70f-d4b985502575", + "type": "rule_group" + }, + { + "children": [ + { + "id": "097dcc4a-375b-4a97-876d-8741b8cfb304", + "type": "rule" + } + ], + "id": "1e106725-351e-421a-9f2a-ab4b9e1de687", + "type": "rule_group" + } + ] + } + }, + "schema": { + "$ref": "#/components/schemas/rule_tree" + } + } + }, + "description": "Returns the Rule Tree of a Profile" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Profile": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Profile not found with ID 75f9976c-cc23-4710-bc85-5fe56477b444" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request the Rule Tree of a Profile", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/profiles/{profile_id}/rules": { + "get": { + "description": "Retrieve a list of all security guide rules for a specific profile.", + "operationId": "ProfileRules", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "severity", + "precedence", + "remediation_available", + "title:asc", + "title:desc", + "severity:asc", + "severity:desc", + "precedence:asc", + "precedence:desc", + "remediation_available:asc", + "remediation_available:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rules are searchable using attributes `title`, `severity`, `remediation_available`, and `rule_group_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "profile_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Rules": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Qui hic commodi. Ut a qui. Minus atque molestiae.", + "id": "0a5acad8-353e-4ea7-848a-e7f5f1d7d8aa", + "identifier": { + "href": "http://moen.example/marcos", + "label": "Merimas Brandybuck" + }, + "precedence": 5870, + "rationale": "Nemo ratione vero. Est cum consequatur. Dignissimos et et.", + "ref_id": "xccdf_org.ssgproject.content_rule_ae5bbef52fb6cf9c21895304fa906e99", + "references": [ + { + "href": "http://cruickshank.example/floretta.larkin", + "label": "Gilbarad" + }, + { + "href": "http://kautzer.example/arturo", + "label": "Lúthien" + }, + { + "href": "http://trantow.example/carissa_herzog", + "label": "Beleth" + }, + { + "href": "http://rau-walsh.test/matilde.krajcik", + "label": "Berelach" + }, + { + "href": "http://feest-von.test/yong", + "label": "Wídfara" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "fcc7e51b-b442-49cf-970d-bd245e419cf6", + "severity": "medium", + "title": "Nisi amet eius velit.", + "type": "rule", + "value_checks": null + }, + { + "description": "Non eum assumenda. Consequuntur laboriosam reiciendis. Nostrum libero molestiae.", + "id": "1c8ea73b-f716-41f0-8e4c-9a440e25ac8a", + "identifier": { + "href": "http://abshire.example/hiram_will", + "label": "Gerda Boffin" + }, + "precedence": 7352, + "rationale": "Vitae ab saepe. Maiores commodi dolor. Adipisci occaecati vel.", + "ref_id": "xccdf_org.ssgproject.content_rule_d837f17730c26a42c638dddb09da3b53", + "references": [ + { + "href": "http://ferry.test/tena_sawayn", + "label": "Calmacil" + }, + { + "href": "http://powlowski.test/giuseppina.trantow", + "label": "Orgulas Brandybuck" + }, + { + "href": "http://metz.example/sparkle", + "label": "Merry Gardner" + }, + { + "href": "http://towne-kozey.example/candida", + "label": "Gandalf" + }, + { + "href": "http://nader.test/jerrod", + "label": "Belba Baggins" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "48d64f27-5854-4e36-acf1-c4b5ebc2a159", + "severity": "low", + "title": "Libero aperiam sit officiis.", + "type": "rule", + "value_checks": null + }, + { + "description": "Mollitia sint culpa. Quibusdam consectetur illo. Aut sit ut.", + "id": "26203892-7287-47d3-a03a-9109583858d5", + "identifier": { + "href": "http://goyette.test/stan", + "label": "Hending" + }, + "precedence": 8225, + "rationale": "Quia quisquam velit. Odit perferendis velit. Accusantium nam nihil.", + "ref_id": "xccdf_org.ssgproject.content_rule_6bc2bdb176ad5b667df1520c6bf0c797", + "references": [ + { + "href": "http://dicki-hills.example/dirk", + "label": "Hob Hayward" + }, + { + "href": "http://dickens-fahey.example/merlyn_larkin", + "label": "Drogo Baggins" + }, + { + "href": "http://weissnat.example/gretta", + "label": "Falco Chubb-Baggins" + }, + { + "href": "http://wyman-reinger.example/landon", + "label": "Gwaihir" + }, + { + "href": "http://krajcik-lesch.example/barrett", + "label": "Nessanië" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "1dc604dc-4829-4c00-8d2a-0aa5796a4e3d", + "severity": "high", + "title": "Ut ea dolor saepe.", + "type": "rule", + "value_checks": null + }, + { + "description": "Rerum voluptas deserunt. Qui quod voluptatem. Nostrum aut reprehenderit.", + "id": "3749991c-0d63-4250-abd6-0dafd0cfae20", + "identifier": { + "href": "http://jakubowski-rempel.test/ike", + "label": "Éothain" + }, + "precedence": 3524, + "rationale": "Qui voluptate facere. Vitae perspiciatis et. Et est sit.", + "ref_id": "xccdf_org.ssgproject.content_rule_a969cd59ca08e77733bee8059d3d9f3d", + "references": [ + { + "href": "http://treutel.example/rina.mertz", + "label": "Ulwarth" + }, + { + "href": "http://bartoletti.example/davis_schmitt", + "label": "Herendil" + }, + { + "href": "http://bauch-okon.example/gennie_fay", + "label": "Arminas" + }, + { + "href": "http://gulgowski-ullrich.test/carrol.roberts", + "label": "Donnamira Took" + }, + { + "href": "http://bruen-bartell.test/tijuana", + "label": "Inziladûn" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "10473851-8f03-4c23-a02c-b65850f48c02", + "severity": "medium", + "title": "Assumenda aliquam iusto odit.", + "type": "rule", + "value_checks": null + }, + { + "description": "Saepe eum inventore. Ab accusamus enim. Debitis vel in.", + "id": "3ed761ae-5b5a-4555-b98c-74b7d8771ed9", + "identifier": { + "href": "http://konopelski.test/leora", + "label": "Thorin" + }, + "precedence": 5105, + "rationale": "Quibusdam consequatur possimus. Sit necessitatibus similique. Totam esse nesciunt.", + "ref_id": "xccdf_org.ssgproject.content_rule_62653a932d1f6f3f2a966781f954336a", + "references": [ + { + "href": "http://sipes-considine.test/harold_stiedemann", + "label": "Harding of the Hill" + }, + { + "href": "http://toy.test/raymond.robel", + "label": "Telchar" + }, + { + "href": "http://bogisich.example/eileen.dooley", + "label": "Helm" + }, + { + "href": "http://gutkowski-kunde.test/theo.abbott", + "label": "Araphor" + }, + { + "href": "http://friesen.test/carl", + "label": "Landroval" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "d5419adf-04f4-458c-b18b-269188fba13a", + "severity": "high", + "title": "Eum cupiditate ducimus tempora.", + "type": "rule", + "value_checks": null + }, + { + "description": "Quos qui optio. Dolores accusamus rerum. Tempora dolore voluptas.", + "id": "46f1414c-b17b-4a0e-84d0-c100dce6930e", + "identifier": { + "href": "http://erdman.example/hana_windler", + "label": "Hamfast Gardner" + }, + "precedence": 1583, + "rationale": "Aut eligendi qui. A ipsa animi. Ex tempora qui.", + "ref_id": "xccdf_org.ssgproject.content_rule_48ed92cb834d8ea3b581669eb1fbe95d", + "references": [ + { + "href": "http://shanahan.example/phil.howe", + "label": "Agathor" + }, + { + "href": "http://huels-mosciski.test/cletus", + "label": "Otto Boffin" + }, + { + "href": "http://steuber.example/tanna", + "label": "Tar-Aldarion" + }, + { + "href": "http://greenfelder-dicki.example/reed_strosin", + "label": "Rowan" + }, + { + "href": "http://wintheiser-pacocha.example/jacques_ernser", + "label": "Finbor" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "72aeef62-0eb5-483e-b415-f7d58534c0d7", + "severity": "medium", + "title": "Commodi modi in eveniet.", + "type": "rule", + "value_checks": null + }, + { + "description": "Veniam nobis quae. Natus voluptatem recusandae. Est aut tenetur.", + "id": "54223f72-f475-42ee-b998-7cc687c3c1b0", + "identifier": { + "href": "http://murphy-breitenberg.example/milton", + "label": "Almarian" + }, + "precedence": 2689, + "rationale": "Molestiae aut delectus. Ad iusto facere. Voluptates reiciendis tempora.", + "ref_id": "xccdf_org.ssgproject.content_rule_a11727f611bd7051f54f29a89c8a35a4", + "references": [ + { + "href": "http://stoltenberg-waters.example/renay", + "label": "Mosco Burrows" + }, + { + "href": "http://kuhic.test/gudrun", + "label": "Hallacar" + }, + { + "href": "http://rowe-schmeler.test/ninfa", + "label": "Vidumavi" + }, + { + "href": "http://bauch.example/dusty_mcglynn", + "label": "Celeborn" + }, + { + "href": "http://heidenreich.example/alisia", + "label": "Poldor" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "96fb7e2f-f5f2-4a9b-84a6-816986b1aea1", + "severity": "high", + "title": "Dicta quia voluptates laudantium.", + "type": "rule", + "value_checks": null + }, + { + "description": "Vel possimus neque. Non dolorem est. Consectetur dolores perferendis.", + "id": "5f164ac1-f366-4037-912c-52a8e7ad653a", + "identifier": { + "href": "http://harber.test/hong", + "label": "Iago Grubb" + }, + "precedence": 7094, + "rationale": "Quis in sapiente. Blanditiis incidunt officia. Nihil commodi nam.", + "ref_id": "xccdf_org.ssgproject.content_rule_274800d52a423b3d5bc01d1a0de41343", + "references": [ + { + "href": "http://walter.example/collen", + "label": "Nienor" + }, + { + "href": "http://hilpert.example/colby_dubuque", + "label": "Grimbold" + }, + { + "href": "http://schaefer-torp.test/delana", + "label": "Aranuir" + }, + { + "href": "http://king-ankunding.example/arden", + "label": "Robin Smallburrow" + }, + { + "href": "http://pouros.test/kathyrn", + "label": "Tar-Aldarion" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "6083b4a9-bbeb-425c-8a96-0f6fe0b3ee44", + "severity": "high", + "title": "Quia quos et amet.", + "type": "rule", + "value_checks": null + }, + { + "description": "Id veritatis amet. Voluptates labore autem. Assumenda hic est.", + "id": "89633eb3-64a5-4568-b822-4d03565ace9f", + "identifier": { + "href": "http://sanford-oconner.test/trevor", + "label": "Belladonna Took" + }, + "precedence": 2998, + "rationale": "Minima voluptatem debitis. Dolorem quae velit. Consequatur maiores eos.", + "ref_id": "xccdf_org.ssgproject.content_rule_c0dbbc48dcfe6916698c1babdc5e7715", + "references": [ + { + "href": "http://fadel.test/tonia.huel", + "label": "Morwë" + }, + { + "href": "http://hermann.test/renato", + "label": "Déorwine" + }, + { + "href": "http://boehm.test/jonelle", + "label": "Ondoher" + }, + { + "href": "http://ratke.example/hubert", + "label": "Brego" + }, + { + "href": "http://jones.test/violeta", + "label": "Valandil" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "61685787-7ab2-403d-9695-b5c09c7510bd", + "severity": "medium", + "title": "Sapiente recusandae iure fugiat.", + "type": "rule", + "value_checks": null + }, + { + "description": "Maiores blanditiis cumque. Aliquid adipisci molestiae. Numquam architecto sit.", + "id": "8d63a426-af3f-450e-beb1-305dd1b47852", + "identifier": { + "href": "http://lubowitz-terry.example/jame", + "label": "Azaghâl" + }, + "precedence": 345, + "rationale": "Libero magni nesciunt. Placeat qui facilis. Voluptatem harum ex.", + "ref_id": "xccdf_org.ssgproject.content_rule_78e65d67cc39ad396cf8a16c59acf64b", + "references": [ + { + "href": "http://ratke-spinka.test/terence_nitzsche", + "label": "Meneldor" + }, + { + "href": "http://feest-larkin.example/edmund", + "label": "Beril" + }, + { + "href": "http://schamberger-carroll.test/vicenta", + "label": "Tata" + }, + { + "href": "http://mcclure-kilback.test/stan", + "label": "Menegilda Goold" + }, + { + "href": "http://murazik.test/santo", + "label": "Aldamir" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "f51e160f-59c7-4659-b05f-ec6b25a30261", + "severity": "low", + "title": "Qui aut eius veritatis.", + "type": "rule", + "value_checks": null + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/4091b39f-cd62-497b-a72f-a22ded6618f5/profiles/cec8188c-1f6f-4e8c-8190-19bb2057a198/rules?limit=10&offset=0", + "last": "/api/compliance/v2/security_guides/4091b39f-cd62-497b-a72f-a22ded6618f5/profiles/cec8188c-1f6f-4e8c-8190-19bb2057a198/rules?limit=10&offset=20", + "next": "/api/compliance/v2/security_guides/4091b39f-cd62-497b-a72f-a22ded6618f5/profiles/cec8188c-1f6f-4e8c-8190-19bb2057a198/rules?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + }, + "List of Rules sorted by \"precedence:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Optio magnam quia. Doloribus ut quia. Magni id sequi.", + "id": "7bdc6e5a-063a-42d8-a475-49c5fb33282b", + "identifier": { + "href": "http://lehner.test/kandace", + "label": "May Gamgee" + }, + "precedence": 112, + "rationale": "Consectetur eveniet perferendis. Voluptatem sit aliquam. Officia vero similique.", + "ref_id": "xccdf_org.ssgproject.content_rule_54b93a590699fad3fc2a17900b87c1e3", + "references": [ + { + "href": "http://mraz.test/sandra", + "label": "Isengar Took" + }, + { + "href": "http://ritchie.test/chance", + "label": "Lavender Grubb" + }, + { + "href": "http://prohaska.example/luke.cartwright", + "label": "Irolas" + }, + { + "href": "http://towne-prosacco.test/dwain", + "label": "Pott the Mayor" + }, + { + "href": "http://kuvalis-murphy.test/thuy", + "label": "Ancalagon" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "d27256ad-06ba-4a1c-b9d9-df3981be27ef", + "severity": "medium", + "title": "Nesciunt inventore itaque eos.", + "type": "rule", + "value_checks": null + }, + { + "description": "Iure placeat aut. Natus officiis qui. Soluta in tempore.", + "id": "04e41d23-cfee-4cea-8689-f77c295b60f3", + "identifier": { + "href": "http://muller.test/marcelino_treutel", + "label": "Balbo Baggins" + }, + "precedence": 521, + "rationale": "Id qui occaecati. Dolorem et numquam. Distinctio dolorem doloremque.", + "ref_id": "xccdf_org.ssgproject.content_rule_2f72d92c1f62d45a629435ef9d721f7f", + "references": [ + { + "href": "http://kessler-runte.test/katherin", + "label": "Isildur" + }, + { + "href": "http://hegmann.example/ignacio", + "label": "Mîm" + }, + { + "href": "http://pagac.example/irish", + "label": "Holdwine" + }, + { + "href": "http://baumbach.test/gussie", + "label": "Arador" + }, + { + "href": "http://dooley-nitzsche.test/joelle.borer", + "label": "Linda Baggins" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "d50b2246-c0f8-47f0-b19f-7d3e4f3ac10c", + "severity": "medium", + "title": "Qui aut qui ab.", + "type": "rule", + "value_checks": null + }, + { + "description": "Sit omnis inventore. Fuga reprehenderit sit. Vitae dignissimos laborum.", + "id": "92084661-6054-4cbf-8a4f-5a091abc073c", + "identifier": { + "href": "http://zulauf-jacobi.test/shawana", + "label": "Faramir Took" + }, + "precedence": 771, + "rationale": "Porro minus autem. Veritatis neque qui. Ut laboriosam porro.", + "ref_id": "xccdf_org.ssgproject.content_rule_99a59a815f35910d057ccdf8cf5a0b29", + "references": [ + { + "href": "http://mcglynn-crona.example/enoch_crona", + "label": "Merry Gardner" + }, + { + "href": "http://stoltenberg-breitenberg.example/dennise", + "label": "Magor" + }, + { + "href": "http://cremin-kuhic.example/bambi", + "label": "Tar-Ardamin" + }, + { + "href": "http://krajcik.example/adan", + "label": "Angrim" + }, + { + "href": "http://bruen-gutmann.test/lasandra", + "label": "Oromendil" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "de64a71c-dc8d-4edd-841e-5cc96a4f5be0", + "severity": "low", + "title": "Optio dolorem voluptatem voluptatem.", + "type": "rule", + "value_checks": null + }, + { + "description": "Et quis mollitia. Aspernatur alias assumenda. Odio corrupti illum.", + "id": "00bda511-e7c3-4d1b-a799-f6731f28be86", + "identifier": { + "href": "http://wyman.test/pablo", + "label": "Théodred" + }, + "precedence": 1004, + "rationale": "Eligendi voluptatem placeat. Laboriosam quasi pariatur. Magnam qui eos.", + "ref_id": "xccdf_org.ssgproject.content_rule_d4e66ba7fd23fb3dbc1ed3f3f19d4d55", + "references": [ + { + "href": "http://legros-langosh.test/janae.johns", + "label": "Cottar" + }, + { + "href": "http://dickinson-fritsch.test/gregg_jakubowski", + "label": "Elros" + }, + { + "href": "http://will-feest.example/kristi", + "label": "Tanta Hornblower" + }, + { + "href": "http://schumm-streich.example/sherice", + "label": "Belecthor" + }, + { + "href": "http://bernhard.example/candance", + "label": "Tar-Palantir" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "de4c733c-fa61-43ba-84f6-6b8402ac2d1c", + "severity": "low", + "title": "Dicta rerum expedita et.", + "type": "rule", + "value_checks": null + }, + { + "description": "Dolorem ut qui. Veritatis ab quia. Incidunt voluptatum dolores.", + "id": "e328432a-ae12-4dd9-8d79-ae8ba3c291e5", + "identifier": { + "href": "http://kovacek-kuvalis.test/leo", + "label": "Egalmoth" + }, + "precedence": 2479, + "rationale": "Natus molestiae pariatur. Et itaque ut. Ut vitae doloribus.", + "ref_id": "xccdf_org.ssgproject.content_rule_6169c61ba34be86c9c35d17ef7bca25c", + "references": [ + { + "href": "http://walter-mraz.test/courtney_west", + "label": "Orleg" + }, + { + "href": "http://corkery-hyatt.test/boyd", + "label": "Angrim" + }, + { + "href": "http://hackett-conn.test/wayne", + "label": "Tar-Ancalimon" + }, + { + "href": "http://bednar-ernser.example/jimmy", + "label": "Halfred Gamgee" + }, + { + "href": "http://morissette.test/myrtie", + "label": "Herugar Bolger" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "32989a93-5bf0-49fb-af74-95b62325a937", + "severity": "low", + "title": "Et maiores non consequatur.", + "type": "rule", + "value_checks": null + }, + { + "description": "Sit sunt maxime. Commodi qui atque. Eos et beatae.", + "id": "7ea5b1d2-8880-4e26-990a-b0ad3eec2fd8", + "identifier": { + "href": "http://dicki-grimes.example/oliver", + "label": "Eärendil" + }, + "precedence": 2873, + "rationale": "Saepe voluptatem sed. Esse qui est. Iure ea sequi.", + "ref_id": "xccdf_org.ssgproject.content_rule_e28498cb988f1205256f0a521813fb10", + "references": [ + { + "href": "http://flatley.example/lavenia_skiles", + "label": "Flambard Took" + }, + { + "href": "http://sauer.example/genoveva.donnelly", + "label": "Bucca of the Marish" + }, + { + "href": "http://ondricka.example/nestor", + "label": "Golasgil" + }, + { + "href": "http://okeefe.example/lilliam.koepp", + "label": "Maedhros" + }, + { + "href": "http://lesch.example/ezra_stracke", + "label": "Folco Burrowes" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "f6e1778b-5899-4c82-aba0-9715c138fc3b", + "severity": "high", + "title": "Alias rem voluptatem suscipit.", + "type": "rule", + "value_checks": null + }, + { + "description": "Natus occaecati et. Molestiae ut vitae. Et nisi dolorum.", + "id": "477d8336-b66c-4174-83bf-9e80bf2077dc", + "identifier": { + "href": "http://auer.example/aleen", + "label": "Findis" + }, + "precedence": 2955, + "rationale": "Voluptatem voluptatem maxime. Repudiandae voluptas ratione. Rerum neque consequatur.", + "ref_id": "xccdf_org.ssgproject.content_rule_d7c6870e4de8f5dc242de86935c66a99", + "references": [ + { + "href": "http://lebsack.test/ahmad_yundt", + "label": "Mogru" + }, + { + "href": "http://damore-ruecker.example/bonnie.klocko", + "label": "Tar-Anducal" + }, + { + "href": "http://hoeger.test/catherine", + "label": "Meneldor" + }, + { + "href": "http://becker.example/jaye_ziemann", + "label": "Finwë" + }, + { + "href": "http://yost.example/javier", + "label": "Malva Headstrong" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "cc7a62f2-593a-423a-b9ca-efc2cbff5851", + "severity": "low", + "title": "Quia inventore est suscipit.", + "type": "rule", + "value_checks": null + }, + { + "description": "Doloremque voluptatem rerum. Repellat voluptas numquam. Quia cumque molestias.", + "id": "29399ef6-2869-4b19-8d0e-e2810ac37d32", + "identifier": { + "href": "http://rowe-cole.example/duane", + "label": "Holman Cotton" + }, + "precedence": 3319, + "rationale": "Architecto et quia. Molestiae eveniet minima. Assumenda sapiente sint.", + "ref_id": "xccdf_org.ssgproject.content_rule_111d88a72138e1b785abb32288a479ac", + "references": [ + { + "href": "http://parker.test/johnathan.schuster", + "label": "Blodren" + }, + { + "href": "http://leuschke-ondricka.test/thomasena", + "label": "Arantar" + }, + { + "href": "http://funk.test/coleen", + "label": "Peeping Jack" + }, + { + "href": "http://bins.example/cody", + "label": "Halfred Greenhand" + }, + { + "href": "http://waelchi-lynch.test/chan_cole", + "label": "Fingon" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "db463c50-e826-42be-8682-538d2892a7cd", + "severity": "high", + "title": "Quod sunt perferendis accusamus.", + "type": "rule", + "value_checks": null + }, + { + "description": "Consequatur temporibus cumque. Voluptates et id. Est et aut.", + "id": "c369c24d-ac69-40b6-877b-6cecdb884d23", + "identifier": { + "href": "http://langworth.example/maire", + "label": "Rowan" + }, + "precedence": 3726, + "rationale": "Et ullam et. Et quisquam accusamus. Delectus labore vero.", + "ref_id": "xccdf_org.ssgproject.content_rule_0db8f04583b13e32d08fafeab58fc81d", + "references": [ + { + "href": "http://ondricka.example/melvin", + "label": "Hathaldir" + }, + { + "href": "http://sporer.example/roma.barton", + "label": "Arassuil" + }, + { + "href": "http://brakus.example/aline", + "label": "Turambar" + }, + { + "href": "http://vonrueden.test/jamie", + "label": "Briffo Boffin" + }, + { + "href": "http://treutel.test/irma_langworth", + "label": "Éothain" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "83166c1d-4201-4b94-b6ce-e5a0849a5f0a", + "severity": "low", + "title": "Ut neque ea sapiente.", + "type": "rule", + "value_checks": null + }, + { + "description": "Nulla aperiam qui. Eligendi dicta repellat. Possimus odit dolorem.", + "id": "b102db39-b831-4d91-a12b-c6d448bbeb6f", + "identifier": { + "href": "http://jacobson.test/noelia", + "label": "Daisy Baggins" + }, + "precedence": 3876, + "rationale": "Excepturi occaecati blanditiis. Voluptatum quo voluptas. Dolor modi voluptates.", + "ref_id": "xccdf_org.ssgproject.content_rule_33c1965e14531ec1a9648abe2b61b670", + "references": [ + { + "href": "http://toy.example/hilaria.wiegand", + "label": "Manthor" + }, + { + "href": "http://ortiz-wiza.example/robbie", + "label": "Enerdhil" + }, + { + "href": "http://johnson.example/german", + "label": "Brandir" + }, + { + "href": "http://crist.test/marcelo", + "label": "Harding" + }, + { + "href": "http://hickle-langworth.example/nicholas", + "label": "Mosco Burrows" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "f03b6adc-1bc9-4ce0-9d1b-57a562d921b1", + "severity": "low", + "title": "Ipsum culpa velit ut.", + "type": "rule", + "value_checks": null + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/ab5e120b-5f7f-4d31-ba47-b3108d7d07f7/profiles/84a5e463-9152-4214-92e3-0f4a792d4470/rules?limit=10&offset=0&sort_by=precedence", + "last": "/api/compliance/v2/security_guides/ab5e120b-5f7f-4d31-ba47-b3108d7d07f7/profiles/84a5e463-9152-4214-92e3-0f4a792d4470/rules?limit=10&offset=20&sort_by=precedence", + "next": "/api/compliance/v2/security_guides/ab5e120b-5f7f-4d31-ba47-b3108d7d07f7/profiles/84a5e463-9152-4214-92e3-0f4a792d4470/rules?limit=10&offset=10&sort_by=precedence" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "precedence", + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/rule" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Rules assigned to a Profile" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Rules assigned to a Profile", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/profiles/{profile_id}/rules/{rule_id}": { + "get": { + "description": "Retrieve a specific security guide rule for a specific profile.", + "operationId": "ProfileRule", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "profile_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "UUID or a ref_id with '.' characters replaced with '-'", + "in": "path", + "name": "rule_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Rule": { + "description": "", + "summary": "", + "value": { + "data": { + "description": "Esse corrupti enim. Sunt blanditiis quo. Est et repellat.", + "id": "b0f43f2f-dffe-43c2-b255-ab9a115e9c25", + "identifier": { + "href": "http://halvorson-kirlin.test/chrystal", + "label": "Ithilbor" + }, + "precedence": 6707, + "rationale": "Fugit dolor iusto. Aliquam porro vel. Consequatur nihil odio.", + "ref_id": "xccdf_org.ssgproject.content_rule_d2f7690afac0a2375c3716352d067f68", + "references": [ + { + "href": "http://wilkinson-shields.example/jalisa_ebert", + "label": "Thorin Stonehelm" + }, + { + "href": "http://berge.test/setsuko", + "label": "Elladan" + }, + { + "href": "http://hand.test/oscar_medhurst", + "label": "Telumehtar Umbardacil" + }, + { + "href": "http://simonis-schinner.test/yi.labadie", + "label": "Orgulas Brandybuck" + }, + { + "href": "http://marvin.example/wendell.gusikowski", + "label": "Ruby Gardner" + } + ], + "remediation_available": false, + "remediation_issue_id": null, + "rule_group_id": "d9566e2d-9b35-48cd-9016-f1381e481748", + "severity": "medium", + "title": "Dolorem quas et rerum.", + "type": "rule", + "value_checks": null + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/rule" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Rule assigned to a Profile" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Rule": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Rule not found with ID bffdbfe3-1bc7-4418-a437-ddf579f60ae2" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Rule assigned to a Profile", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/rule_groups": { + "get": { + "description": "List all rules groups.", + "operationId": "Rule Groups", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "precedence", + "precedence:asc", + "precedence:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rule Groups are searchable using attributes `title` and `ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Rule Groups": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Velit doloremque harum. Eaque omnis rerum. Sit sed et.", + "id": "00fb7f96-39aa-4ae9-b7ad-6796d1d1b648", + "precedence": null, + "rationale": "Est perferendis ut. Optio magni doloremque. Voluptates consequatur repudiandae.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_3507e578b6f50ca6db1a70fc7efa7827", + "title": "Sit voluptatem magnam libero.", + "type": "rule_group" + }, + { + "description": "Cumque qui in. Iusto repellendus in. Voluptate rem quos.", + "id": "0932c3a1-8726-4352-8ebb-d6f8635c01f2", + "precedence": null, + "rationale": "Aut fuga cupiditate. Dignissimos sed eum. Vitae optio aut.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_0a60d6a499c0a57f70319e045ca42dc0", + "title": "Libero iusto ut repudiandae.", + "type": "rule_group" + }, + { + "description": "Optio ut autem. Est aut ad. Soluta sit illum.", + "id": "29d1d27f-ada2-4a42-ae24-a8b831b87d0c", + "precedence": null, + "rationale": "Ut dolores totam. Et nam sunt. Asperiores est sit.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_194b73c4fffacdcd8a3eb9026086063f", + "title": "Sint aliquam aut voluptatum.", + "type": "rule_group" + }, + { + "description": "Eaque fuga dolores. Commodi sit ipsa. Consequatur eligendi soluta.", + "id": "42c26aff-66d1-4e31-8224-7b2d5787366e", + "precedence": null, + "rationale": "Sit quia laboriosam. Corrupti aut et. Vitae ullam nulla.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_ea397f96ee117cf63d92f11b75521a5d", + "title": "Sint aut sequi quaerat.", + "type": "rule_group" + }, + { + "description": "Dolor amet sapiente. Vel minus eum. Omnis ipsa repudiandae.", + "id": "4ff799ec-d9a3-4d32-8425-a9bbbffad755", + "precedence": null, + "rationale": "Iure quia architecto. Id quidem molestiae. Excepturi amet ipsa.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_0d08dcc747acbf29e5f9a42a5b18864e", + "title": "Quidem voluptas nihil laudantium.", + "type": "rule_group" + }, + { + "description": "Corporis reprehenderit at. Rerum et pariatur. Et et praesentium.", + "id": "518f15ca-3628-4f7b-b701-fed6d376a994", + "precedence": null, + "rationale": "Natus mollitia quisquam. Dolorem dolores sint. Aut natus nesciunt.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_301c730775e3a17108b73e5e0724e12f", + "title": "Laudantium fugit quaerat quisquam.", + "type": "rule_group" + }, + { + "description": "Facilis quo velit. Dolorem iusto et. Ut labore tempore.", + "id": "6146f8a5-e565-4ff6-a4c4-697cb5b5a023", + "precedence": null, + "rationale": "Accusantium et eos. Dolor esse quidem. Ea doloribus enim.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_7a680979437988141760552cce9d49ab", + "title": "Impedit in qui numquam.", + "type": "rule_group" + }, + { + "description": "Sit mollitia et. Ea provident aut. Quia quas quos.", + "id": "63fe57b0-6e4b-4388-ac9e-b8fb6da09bb9", + "precedence": null, + "rationale": "Quasi laborum inventore. Quis cum numquam. Perferendis voluptas atque.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_0baff8efba7ef8868eb580336b8ad9b1", + "title": "Corporis consequuntur debitis id.", + "type": "rule_group" + }, + { + "description": "Est deleniti voluptatem. Tempore nisi officiis. Et maxime quos.", + "id": "6d6f171a-7aed-442e-8efb-915ac7867b16", + "precedence": null, + "rationale": "Et hic ratione. Vero tenetur sed. Perspiciatis neque consectetur.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_a9d1c52aa63035e7c17afdbdc9929822", + "title": "Accusamus adipisci atque animi.", + "type": "rule_group" + }, + { + "description": "Enim aut optio. Mollitia et quia. Non illum repudiandae.", + "id": "747e752a-b8ce-437b-a0ef-6e41bec4a651", + "precedence": null, + "rationale": "Ipsum eaque sit. Et est aperiam. Et et tenetur.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_90c3b368106a5c4bc802d94f4c05ce4c", + "title": "Quis quia rerum ut.", + "type": "rule_group" + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/b46ceaeb-3695-48ae-83b7-51b6a44bd827/rule_groups?limit=10&offset=0", + "last": "/api/compliance/v2/security_guides/b46ceaeb-3695-48ae-83b7-51b6a44bd827/rule_groups?limit=10&offset=20", + "next": "/api/compliance/v2/security_guides/b46ceaeb-3695-48ae-83b7-51b6a44bd827/rule_groups?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + }, + "List of Rule Groups sorted by \"precedence:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Magnam consequatur aliquid. Est non blanditiis. Temporibus recusandae neque.", + "id": "0f17577f-27c4-4310-af7a-461b63445d86", + "precedence": null, + "rationale": "Sed soluta autem. Odio eaque et. Asperiores exercitationem accusantium.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_24401119ede8dfdfb7d850ac408fa96b", + "title": "Ea veniam enim quaerat.", + "type": "rule_group" + }, + { + "description": "Quibusdam sequi veritatis. Earum porro eum. Vel nobis alias.", + "id": "17494801-aa7c-42ff-a71a-43c4c6bedebd", + "precedence": null, + "rationale": "Debitis magnam delectus. Et exercitationem perferendis. Quidem natus et.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_a8cfe928eefd2c6717d6288d9cbd5bbc", + "title": "Assumenda voluptatum est molestiae.", + "type": "rule_group" + }, + { + "description": "Similique qui dolore. Et aut repellendus. Optio ea asperiores.", + "id": "1fd4628e-e059-4aaf-b6c9-af18f77a21ef", + "precedence": null, + "rationale": "Dicta et non. Ut tenetur modi. Excepturi deleniti omnis.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_5fff8c7706dda1919d61e81559f3c559", + "title": "Perspiciatis voluptatem et eius.", + "type": "rule_group" + }, + { + "description": "Amet cupiditate facere. Consectetur maiores cum. Beatae officia illum.", + "id": "32504d28-81db-46c3-b0b3-13748f3b829e", + "precedence": null, + "rationale": "Expedita et dolorem. Blanditiis adipisci cupiditate. Blanditiis nemo fugit.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_fbeebf53cb8b9bb7c7e5280af396e480", + "title": "Doloribus a et et.", + "type": "rule_group" + }, + { + "description": "Repellat et aut. Occaecati vero similique. Fugit omnis sunt.", + "id": "3eb7e4f5-4a4d-4320-8501-4c8bb4b97c38", + "precedence": null, + "rationale": "At suscipit animi. Qui dolorem culpa. Magnam eius veniam.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_9cda97b336450acf50f40c763e06deae", + "title": "Quas dolores rerum nesciunt.", + "type": "rule_group" + }, + { + "description": "Quia qui inventore. Sapiente sed aliquid. Sint amet officiis.", + "id": "503bca29-4f9d-4b74-840e-edfb375330dc", + "precedence": null, + "rationale": "Deserunt inventore repellat. Qui eaque repellat. Dignissimos autem accusantium.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_b7e5c59eee26ed967d8487b0ab33a94f", + "title": "Ea ullam temporibus velit.", + "type": "rule_group" + }, + { + "description": "Eligendi sint dolor. Quis ut assumenda. Similique quam exercitationem.", + "id": "5635e2e4-5d1d-4de3-9ee2-a2cb7da10bdc", + "precedence": null, + "rationale": "Perspiciatis fuga id. Saepe vitae beatae. Velit magnam eos.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_d28bd15d2f125ad5f4add75a647ce8ff", + "title": "Sit aut ut eos.", + "type": "rule_group" + }, + { + "description": "Qui sint eum. Aut dolores quis. Explicabo accusamus sit.", + "id": "5e13f03b-29cd-47ff-9567-3fc671977377", + "precedence": null, + "rationale": "Est magni architecto. Non et culpa. Qui nostrum quia.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_81fcfb233571e86cded6e6f8de5c7b99", + "title": "Sit veniam sed nesciunt.", + "type": "rule_group" + }, + { + "description": "Repudiandae maiores aut. Consequatur corporis qui. Voluptatem rerum est.", + "id": "66071f23-86bb-4476-837b-aee0436ac1b2", + "precedence": null, + "rationale": "Quas qui maxime. Magni vero iusto. Qui veniam voluptas.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_4bfc3e2c2aeafdf7c6c615bef16aed48", + "title": "Aliquam ut quibusdam id.", + "type": "rule_group" + }, + { + "description": "Labore ad non. Omnis commodi asperiores. Voluptates libero voluptas.", + "id": "66d9aa22-981d-49a6-a030-826855aece33", + "precedence": null, + "rationale": "Consectetur non sunt. Consequuntur quo debitis. Aliquid harum corrupti.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_3d342c4a889e52a0637cd386bc027318", + "title": "Rem rerum culpa omnis.", + "type": "rule_group" + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/a16fb9cc-c09e-41b2-9131-9aae5b8d54ef/rule_groups?limit=10&offset=0&sort_by=precedence", + "last": "/api/compliance/v2/security_guides/a16fb9cc-c09e-41b2-9131-9aae5b8d54ef/rule_groups?limit=10&offset=20&sort_by=precedence", + "next": "/api/compliance/v2/security_guides/a16fb9cc-c09e-41b2-9131-9aae5b8d54ef/rule_groups?limit=10&offset=10&sort_by=precedence" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "precedence", + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/rule_group" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Rule Groups" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Rule Groups", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/rule_groups/{rule_group_id}": { + "get": { + "description": "Retrieve a specific rule group.", + "operationId": "RuleGroup", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "rule_group_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Rule Group": { + "description": "", + "summary": "", + "value": { + "data": { + "description": "Nobis dolor neque. Dolorum voluptatum dolore. Deserunt quos veniam.", + "id": "d963a0e4-b9b6-4978-baf3-09031decefd5", + "precedence": null, + "rationale": "Voluptatem veniam non. Quidem nulla et. Ad quia in.", + "ref_id": "xccdf_org.ssgproject.content_rule_group_ba59b1f28eefe9c3f991429e1e82f23b", + "title": "Labore suscipit doloribus sunt.", + "type": "rule_group" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/rule_group" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Rule Group" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Rule Group": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::RuleGroup not found with ID df2ebffb-bb6e-42d4-9b52-bcf4bc707987" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Rule Group", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/rule_tree": { + "get": { + "deprecated": true, + "description": "Returns rule tree of a security guide.", + "operationId": "SecurityGuideRuleTree", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns the Rule Tree of a Security Guide": { + "description": "", + "summary": "", + "value": [ + { + "children": [ + { + "id": "7fe59cb0-64ad-4ffa-9a91-d4abf6f6b37c", + "type": "rule" + } + ], + "id": "668dd44c-0199-4f48-b243-04e04f576388", + "type": "rule_group" + }, + { + "children": [ + { + "id": "c390bae0-c84f-4ae8-9813-f6ccb36ad352", + "type": "rule" + } + ], + "id": "8d1ed432-c60e-42d1-a8e0-8e417fabb9d6", + "type": "rule_group" + }, + { + "children": [ + { + "id": "22c1cc85-075b-4149-981f-af408506098e", + "type": "rule" + } + ], + "id": "7e3f27bd-e3fc-4c35-ae96-6204d4ebe34f", + "type": "rule_group" + }, + { + "children": [ + { + "id": "8f96ab25-3cd1-4720-8914-c70773190e73", + "type": "rule" + } + ], + "id": "57673e38-a100-4003-8443-047538762883", + "type": "rule_group" + }, + { + "children": [ + { + "id": "26e217c8-8095-4588-a1e6-c04adc5b7a40", + "type": "rule" + } + ], + "id": "601fb315-a1af-47e0-9d2a-a11c5055dced", + "type": "rule_group" + }, + { + "children": [ + { + "id": "6de2d83e-8fb2-4e7b-85ad-4b844d18af07", + "type": "rule" + } + ], + "id": "bb41c298-2328-438e-90dd-aa7d251ecf24", + "type": "rule_group" + }, + { + "children": [ + { + "id": "815481c5-293f-462d-a0ff-dd9e477fb420", + "type": "rule" + } + ], + "id": "b463185d-37cd-46d9-8ef0-499011450d40", + "type": "rule_group" + }, + { + "children": [ + { + "id": "032b6571-ae31-4526-9611-cab8b39604d3", + "type": "rule" + } + ], + "id": "eb2d7918-af46-436d-a6e8-6770b9992323", + "type": "rule_group" + }, + { + "children": [ + { + "id": "a83adfa2-414d-4ab0-8679-eba85647d3a0", + "type": "rule" + } + ], + "id": "9c5a225f-7ad1-408b-8b5c-5ab6785c3fd7", + "type": "rule_group" + }, + { + "children": [ + { + "id": "0f93d69d-6bc3-4f00-adaf-886d8223d5f6", + "type": "rule" + } + ], + "id": "b4a0b913-c024-4eb4-a99d-7c6e03bf7817", + "type": "rule_group" + } + ] + } + }, + "schema": { + "$ref": "#/components/schemas/rule_tree" + } + } + }, + "description": "Returns the Rule Tree of a Security Guide" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Security Guide": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::SecurityGuide not found with ID c0da4edc-57a5-41ed-8796-6e1915a28682" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request the Rule Tree of a Security Guide", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/rules": { + "get": { + "description": "Retrieve a list of rules for a specific security guide.", + "operationId": "Rules", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "severity", + "precedence", + "remediation_available", + "title:asc", + "title:desc", + "severity:asc", + "severity:desc", + "precedence:asc", + "precedence:desc", + "remediation_available:asc", + "remediation_available:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rules are searchable using attributes `title`, `severity`, `remediation_available`, and `rule_group_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Rules": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Omnis dolorem sed. Praesentium quos assumenda. Id sapiente voluptatem.", + "id": "023be570-5f1d-43e3-8f28-bda7df80b462", + "identifier": { + "href": "http://baumbach.test/rodolfo", + "label": "Cotman" + }, + "precedence": 1436, + "rationale": "Iste et repellat. Aperiam voluptatibus et. Est id quibusdam.", + "ref_id": "xccdf_org.ssgproject.content_rule_d8273354e443d95646f7d94fb28b1910", + "references": [ + { + "href": "http://legros-hegmann.example/winfred", + "label": "Gamil Zirak" + }, + { + "href": "http://mayert-kunze.test/talitha", + "label": "Beorn" + }, + { + "href": "http://abbott.test/meggan.casper", + "label": "Yávien" + }, + { + "href": "http://crist.example/corrina_reynolds", + "label": "Beregar" + }, + { + "href": "http://ziemann.example/jan.leffler", + "label": "Grishnákh" + } + ], + "remediation_available": false, + "rule_group_id": "e7788034-f884-49cc-8089-2d46eb3e8df6", + "severity": "low", + "title": "Provident in sit quis.", + "type": "rule", + "value_checks": null + }, + { + "description": "Alias et voluptas. Dolores voluptas ea. Explicabo animi est.", + "id": "0f7b2736-2828-42fd-b863-992ba5e14f8c", + "identifier": { + "href": "http://carroll-haley.example/everett.little", + "label": "Shelob" + }, + "precedence": 5284, + "rationale": "Doloribus nemo ad. Accusantium omnis voluptatem. Minima ut velit.", + "ref_id": "xccdf_org.ssgproject.content_rule_cdfca5ac2756ec6d7d52f4e5945e14cb", + "references": [ + { + "href": "http://parisian.test/rubin.dach", + "label": "Gollum" + }, + { + "href": "http://carter.example/isaura_king", + "label": "Tarannon Falastur" + }, + { + "href": "http://stoltenberg.test/karma", + "label": "Estella Bolger" + }, + { + "href": "http://lowe.test/kristopher", + "label": "Merimac Brandybuck" + }, + { + "href": "http://altenwerth.test/betsey.franecki", + "label": "Frór" + } + ], + "remediation_available": false, + "rule_group_id": "c3b3ea8c-f405-4b50-bb65-b0768dff4dd6", + "severity": "medium", + "title": "Totam rem in non.", + "type": "rule", + "value_checks": null + }, + { + "description": "Modi non nemo. Natus iste voluptas. Minus magni veritatis.", + "id": "23daaaec-c098-48a5-9fa3-6d8166c632c5", + "identifier": { + "href": "http://huels-considine.example/debera", + "label": "Hild" + }, + "precedence": 8567, + "rationale": "Nam et adipisci. Quia vel rem. Porro rem dolores.", + "ref_id": "xccdf_org.ssgproject.content_rule_2445cbb9bd587c4b0eb458a29d9c1f83", + "references": [ + { + "href": "http://ankunding-altenwerth.example/karlyn.oconner", + "label": "Rose Gardner" + }, + { + "href": "http://breitenberg.example/morris_stokes", + "label": "Belegund" + }, + { + "href": "http://romaguera.test/anne_green", + "label": "Aravorn" + }, + { + "href": "http://goodwin-kshlerin.example/kristopher.swaniawski", + "label": "Cora Goodbody" + }, + { + "href": "http://pfeffer.test/gregory_hamill", + "label": "Orodreth" + } + ], + "remediation_available": false, + "rule_group_id": "82d0b961-5438-4fb8-a3cb-63b39b34125a", + "severity": "medium", + "title": "Qui dicta fugit et.", + "type": "rule", + "value_checks": null + }, + { + "description": "Id nesciunt labore. Consectetur sint est. Aliquam laudantium qui.", + "id": "26df5848-42e4-4111-b8da-523c036711f4", + "identifier": { + "href": "http://green-anderson.example/mauro.west", + "label": "Mallor" + }, + "precedence": 8607, + "rationale": "Corporis dolorem sint. Iste ea enim. Aut a occaecati.", + "ref_id": "xccdf_org.ssgproject.content_rule_10d231520f01ef5d2b3e007d5e153da4", + "references": [ + { + "href": "http://quigley.example/joaquin_grimes", + "label": "Eldacar" + }, + { + "href": "http://herzog-wiza.example/jeffery_grady", + "label": "Cora Goodbody" + }, + { + "href": "http://schmidt.test/sophie", + "label": "Brodda" + }, + { + "href": "http://haley.test/coy", + "label": "Erkenbrand" + }, + { + "href": "http://borer-cassin.example/kaitlyn_brown", + "label": "Forlong" + } + ], + "remediation_available": false, + "rule_group_id": "5e08984e-f183-4d20-87d7-56676ee772f8", + "severity": "medium", + "title": "Perspiciatis debitis sint officia.", + "type": "rule", + "value_checks": null + }, + { + "description": "Dolor numquam magnam. Natus et quae. Beatae ea iure.", + "id": "42d46161-51b3-4ba6-85b3-65589e007266", + "identifier": { + "href": "http://kuphal.test/jamar", + "label": "Inzilbêth" + }, + "precedence": 9735, + "rationale": "Sed expedita aut. Architecto non temporibus. Ad numquam aut.", + "ref_id": "xccdf_org.ssgproject.content_rule_09777066185cb7fc9bc51d255a19d477", + "references": [ + { + "href": "http://ward.example/ruby", + "label": "Huor" + }, + { + "href": "http://walsh.example/clarence.botsford", + "label": "Aranwë" + }, + { + "href": "http://quitzon-rempel.test/nadia", + "label": "Elenwë" + }, + { + "href": "http://cassin-kunze.example/rich.hand", + "label": "Imrahil" + }, + { + "href": "http://muller-ohara.example/timmy", + "label": "Imrahil" + } + ], + "remediation_available": false, + "rule_group_id": "15285618-2ece-43ec-8a61-706a0621b7ab", + "severity": "medium", + "title": "Dignissimos ut natus asperiores.", + "type": "rule", + "value_checks": null + }, + { + "description": "Quisquam voluptas atque. Voluptatem animi sunt. Error culpa ex.", + "id": "4df2bc8d-4147-455a-9a8f-92951d7f10f7", + "identifier": { + "href": "http://bernhard-pollich.test/cassi.kovacek", + "label": "Nessanië" + }, + "precedence": 7869, + "rationale": "Id quis vitae. Architecto quibusdam nihil. Ad et labore.", + "ref_id": "xccdf_org.ssgproject.content_rule_292ddaca3c3b655879d545013d21aa6c", + "references": [ + { + "href": "http://beier-wisozk.test/wan.koelpin", + "label": "Nurwë" + }, + { + "href": "http://lynch.example/louis", + "label": "Wiseman Gamwich" + }, + { + "href": "http://nikolaus.test/jasper", + "label": "Sangahyando" + }, + { + "href": "http://gleason.test/antonia.bruen", + "label": "Laura Grubb" + }, + { + "href": "http://pacocha.test/ronald_ruecker", + "label": "Valacar" + } + ], + "remediation_available": false, + "rule_group_id": "200821b6-63df-4117-8f4e-c9592e013d02", + "severity": "low", + "title": "Ut laudantium magnam id.", + "type": "rule", + "value_checks": null + }, + { + "description": "Delectus nam consequatur. Odio ut ut. Aut dignissimos aut.", + "id": "5f2556f8-bb18-4574-96b4-15f30fc66a0d", + "identifier": { + "href": "http://osinski.test/teodoro.wiza", + "label": "Telchar" + }, + "precedence": 6767, + "rationale": "Dolore et debitis. Amet minima magni. Deserunt iusto aliquam.", + "ref_id": "xccdf_org.ssgproject.content_rule_0f99a7793b145cfb2469b459a7a47425", + "references": [ + { + "href": "http://koch-schoen.test/dewayne", + "label": "Gorbadoc Brandybuck" + }, + { + "href": "http://stokes-gibson.test/rickie.moore", + "label": "Eilinel" + }, + { + "href": "http://schumm.test/patrick", + "label": "Ingwion" + }, + { + "href": "http://trantow.test/roland", + "label": "Gilly Brownlock" + }, + { + "href": "http://lesch.test/royce_yost", + "label": "Caliondo" + } + ], + "remediation_available": false, + "rule_group_id": "04d44a81-e5ea-4a68-8211-71178cab9e38", + "severity": "high", + "title": "Sint voluptates quis eligendi.", + "type": "rule", + "value_checks": null + }, + { + "description": "Excepturi ducimus et. Et est vel. Dolore impedit ut.", + "id": "604a3af9-d983-4a73-b7c9-bcd6cda41a96", + "identifier": { + "href": "http://adams-braun.test/devin", + "label": "Mairen" + }, + "precedence": 6500, + "rationale": "Sed fuga voluptatem. Officia reiciendis sed. Hic voluptas nesciunt.", + "ref_id": "xccdf_org.ssgproject.content_rule_0a5e8fe8074a24b3abad44733508e7ab", + "references": [ + { + "href": "http://beahan.test/margarito.bradtke", + "label": "Náin" + }, + { + "href": "http://kris.example/trula", + "label": "Belen" + }, + { + "href": "http://pfannerstill.example/reba_goldner", + "label": "Daisy Baggins" + }, + { + "href": "http://rempel.test/leeanna.hansen", + "label": "Isembard Took" + }, + { + "href": "http://leuschke.test/hugo", + "label": "Othrondir" + } + ], + "remediation_available": false, + "rule_group_id": "4845c31f-9fee-4c50-aca4-d2fd0d401985", + "severity": "high", + "title": "Minima amet ea harum.", + "type": "rule", + "value_checks": null + }, + { + "description": "Sed alias harum. Quidem eaque eos. Et molestias omnis.", + "id": "6ad27251-d380-4a26-8abb-bc808c80a057", + "identifier": { + "href": "http://gottlieb.test/helen", + "label": "Rollo Boffin" + }, + "precedence": 9859, + "rationale": "Unde corrupti ea. Voluptatum vero est. Labore maiores non.", + "ref_id": "xccdf_org.ssgproject.content_rule_6dcace801c14c87f70e1b1986185c8d4", + "references": [ + { + "href": "http://white.example/vikki", + "label": "Lalaith" + }, + { + "href": "http://lindgren-herman.example/tangela", + "label": "Khamûl" + }, + { + "href": "http://labadie.test/tuan", + "label": "Nar" + }, + { + "href": "http://wehner.test/cinthia", + "label": "Lóni" + }, + { + "href": "http://toy-hartmann.example/tyrone", + "label": "Borin" + } + ], + "remediation_available": false, + "rule_group_id": "f3bcd5af-9c81-4d7c-a68d-f2bec00a4ae0", + "severity": "medium", + "title": "Molestias aspernatur voluptatem earum.", + "type": "rule", + "value_checks": null + }, + { + "description": "Accusamus tempore iure. Et veniam quia. Est aut et.", + "id": "7d2e28aa-7940-4ee5-95b9-3d4f1494d079", + "identifier": { + "href": "http://okuneva.example/luvenia", + "label": "Nolondil" + }, + "precedence": 3546, + "rationale": "Corporis et et. Occaecati aliquid optio. Sequi cupiditate earum.", + "ref_id": "xccdf_org.ssgproject.content_rule_bee0b5ca5269369c28f69320e875c60b", + "references": [ + { + "href": "http://cummerata-kemmer.test/aleen", + "label": "Uldor" + }, + { + "href": "http://kuvalis.test/chieko_schuppe", + "label": "Bifur" + }, + { + "href": "http://feest.example/brice", + "label": "Tar-Alcarin" + }, + { + "href": "http://luettgen.test/joie", + "label": "Barahir" + }, + { + "href": "http://schinner-swaniawski.example/alfonzo.koch", + "label": "Mithrellas" + } + ], + "remediation_available": false, + "rule_group_id": "1168a1b7-0f72-41ad-968c-2ad92dc84c4d", + "severity": "high", + "title": "Ex numquam consequatur unde.", + "type": "rule", + "value_checks": null + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/6d0c9ce0-5e8c-43b8-8ed7-9572faea8d49/rules?limit=10&offset=0", + "last": "/api/compliance/v2/security_guides/6d0c9ce0-5e8c-43b8-8ed7-9572faea8d49/rules?limit=10&offset=20", + "next": "/api/compliance/v2/security_guides/6d0c9ce0-5e8c-43b8-8ed7-9572faea8d49/rules?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + }, + "List of Rules sorted by \"precedence:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "description": "Et ut est. Quia tempora totam. Doloribus enim et.", + "id": "b3688fea-c928-40d2-80b4-3aa45a34cfa4", + "identifier": { + "href": "http://cronin.test/jefferey.hamill", + "label": "Almarian" + }, + "precedence": 257, + "rationale": "Fugiat commodi et. Deleniti et eos. Magnam dolores harum.", + "ref_id": "xccdf_org.ssgproject.content_rule_8026cf3e5b8802436cf3e4b56704792e", + "references": [ + { + "href": "http://brown-kertzmann.example/doretha_nienow", + "label": "Elwing" + }, + { + "href": "http://reichel-kuhic.test/kristyn_paucek", + "label": "Bombur" + }, + { + "href": "http://wolf.example/latrisha.sauer", + "label": "Lindir" + }, + { + "href": "http://collins.example/jeannine.wilkinson", + "label": "Írimon" + }, + { + "href": "http://nienow.test/omer", + "label": "Elwing" + } + ], + "remediation_available": false, + "rule_group_id": "a883761c-78fa-4845-9422-5bc63f4872e2", + "severity": "low", + "title": "Exercitationem sed quaerat quibusdam.", + "type": "rule", + "value_checks": null + }, + { + "description": "Voluptas quo pariatur. Vero facilis ut. Incidunt possimus laboriosam.", + "id": "71408b55-c604-4b18-89d9-9109ecec3eca", + "identifier": { + "href": "http://dubuque-krajcik.example/lorie", + "label": "Posco Baggins" + }, + "precedence": 762, + "rationale": "Reprehenderit autem aliquam. Molestias ex repellat. Reprehenderit qui error.", + "ref_id": "xccdf_org.ssgproject.content_rule_bd2426d8f96691bd7516eb35ed5d9d8c", + "references": [ + { + "href": "http://breitenberg.test/bertram.douglas", + "label": "Rowan" + }, + { + "href": "http://weimann.example/maribeth", + "label": "Ciryatur" + }, + { + "href": "http://dickens.test/venice.nader", + "label": "Daisy Gardner" + }, + { + "href": "http://will-wehner.test/jacquiline", + "label": "Forthwini" + }, + { + "href": "http://turcotte-schneider.test/gayle.smith", + "label": "Gaffer Gamgee" + } + ], + "remediation_available": false, + "rule_group_id": "62435910-bfb5-436a-8689-1270004a1835", + "severity": "medium", + "title": "Enim ducimus ut minima.", + "type": "rule", + "value_checks": null + }, + { + "description": "Fuga odit quia. Quidem iusto similique. Aliquid quaerat molestiae.", + "id": "ef63cd66-be50-4985-96bc-de6688c9015d", + "identifier": { + "href": "http://pacocha.test/debby.walsh", + "label": "Andwise Roper" + }, + "precedence": 950, + "rationale": "Aut autem velit. Minima voluptas ut. Ipsam et et.", + "ref_id": "xccdf_org.ssgproject.content_rule_3a6d14330c7177a6fd011cbb8f51f50d", + "references": [ + { + "href": "http://kovacek.example/bonnie_okuneva", + "label": "Eärendil" + }, + { + "href": "http://wiegand.example/diego_schaefer", + "label": "Gilly Brownlock" + }, + { + "href": "http://oconner.test/libby.dicki", + "label": "Finwë" + }, + { + "href": "http://thompson-schmitt.example/jim", + "label": "Isildur" + }, + { + "href": "http://feil-gulgowski.example/adolph", + "label": "Castamir" + } + ], + "remediation_available": false, + "rule_group_id": "12858593-b223-48d2-acd8-f2116cdb2813", + "severity": "medium", + "title": "Voluptas dolorem labore et.", + "type": "rule", + "value_checks": null + }, + { + "description": "Expedita dolores debitis. Aut necessitatibus a. Soluta quas voluptates.", + "id": "6d2e89fb-a3a5-4776-989b-ba9bdd179a51", + "identifier": { + "href": "http://heathcote-funk.test/francis", + "label": "Melilot Brandybuck" + }, + "precedence": 1148, + "rationale": "Repellendus nostrum adipisci. Saepe ut odit. Quia quaerat reprehenderit.", + "ref_id": "xccdf_org.ssgproject.content_rule_4ddb7c2fed4080eff1926abee5ee44f0", + "references": [ + { + "href": "http://feil.test/ricardo_wiegand", + "label": "Adalgar Bolger" + }, + { + "href": "http://stoltenberg.test/brett", + "label": "Robin Smallburrow" + }, + { + "href": "http://mante.example/florance.gorczany", + "label": "Dúnhere" + }, + { + "href": "http://prohaska-price.test/denice", + "label": "Beren" + }, + { + "href": "http://balistreri.example/na.mertz", + "label": "Elrond" + } + ], + "remediation_available": false, + "rule_group_id": "ca8dd619-0f18-4a40-a6e0-3ee5c564f314", + "severity": "low", + "title": "Quisquam perferendis consequuntur praesentium.", + "type": "rule", + "value_checks": null + }, + { + "description": "Hic voluptatem dolores. Ex reprehenderit et. Ut maiores autem.", + "id": "4caaad40-0bff-4fb2-8f5b-cad4935767b3", + "identifier": { + "href": "http://bernier.example/shaun.feeney", + "label": "Celeborn" + }, + "precedence": 1903, + "rationale": "Exercitationem cupiditate et. Repellendus alias dolor. Provident illum ut.", + "ref_id": "xccdf_org.ssgproject.content_rule_3594081d8fbf8e54d79e9d916eb2f531", + "references": [ + { + "href": "http://senger.example/darline", + "label": "Dírhael" + }, + { + "href": "http://bins.test/terence_satterfield", + "label": "Gundabald Bolger" + }, + { + "href": "http://champlin-bradtke.example/lincoln.heaney", + "label": "Forweg" + }, + { + "href": "http://bailey.test/dante_hammes", + "label": "Marmadas Brandybuck" + }, + { + "href": "http://watsica.test/vernia", + "label": "Farmer Maggot" + } + ], + "remediation_available": false, + "rule_group_id": "6f81b149-a497-4396-a334-7b5366214b8a", + "severity": "medium", + "title": "Voluptas enim nam nihil.", + "type": "rule", + "value_checks": null + }, + { + "description": "Qui sed debitis. Enim saepe optio. Quia accusantium et.", + "id": "d22e2631-a5f6-4662-943a-2950aaf5cb78", + "identifier": { + "href": "http://bauch.example/rachelle.carter", + "label": "Elanor Gardner" + }, + "precedence": 2454, + "rationale": "Sed aut provident. Illum autem minima. Aut eaque voluptas.", + "ref_id": "xccdf_org.ssgproject.content_rule_8382fd403599a2b6ae7c350d4ba111b7", + "references": [ + { + "href": "http://prosacco.test/travis", + "label": "Radagast" + }, + { + "href": "http://brown.test/haydee.littel", + "label": "Aghan" + }, + { + "href": "http://johnston.example/rosetta", + "label": "Faniel" + }, + { + "href": "http://hudson.example/jesse", + "label": "Morwen Steelsheen" + }, + { + "href": "http://huel.test/gregorio.murray", + "label": "Ornendil" + } + ], + "remediation_available": false, + "rule_group_id": "858bf8f0-dcf3-45e8-a6a6-c76a6fca462f", + "severity": "medium", + "title": "In commodi incidunt deleniti.", + "type": "rule", + "value_checks": null + }, + { + "description": "Accusantium adipisci praesentium. Expedita doloribus quibusdam. Accusamus reprehenderit sunt.", + "id": "7ef65724-074d-42d1-8401-5aaf19cd7f5a", + "identifier": { + "href": "http://blanda.test/otha.lemke", + "label": "Gimli" + }, + "precedence": 2552, + "rationale": "Doloremque blanditiis a. Fugit repudiandae nisi. Laborum odio tempore.", + "ref_id": "xccdf_org.ssgproject.content_rule_b5054204e1dc727e23b571d667133d93", + "references": [ + { + "href": "http://ullrich.example/gala_emard", + "label": "Ingwion" + }, + { + "href": "http://kihn.test/nichole", + "label": "Borin" + }, + { + "href": "http://bogan.test/christoper.kassulke", + "label": "Adamanta Chubb" + }, + { + "href": "http://hoppe-haag.example/tashina.schmeler", + "label": "Eorl" + }, + { + "href": "http://altenwerth.test/shauna.mcglynn", + "label": "Hamfast Gardner" + } + ], + "remediation_available": false, + "rule_group_id": "7b12f802-d01b-4bd3-a2a7-21abe24360f7", + "severity": "low", + "title": "Dolor quisquam at error.", + "type": "rule", + "value_checks": null + }, + { + "description": "Voluptatum et ut. Molestiae amet perferendis. Aliquam quia aut.", + "id": "c750caef-cf90-49be-abc1-e4b32b353b23", + "identifier": { + "href": "http://labadie.test/kenyatta", + "label": "Roäc" + }, + "precedence": 3478, + "rationale": "Consequuntur nam laborum. Nam qui consequuntur. Et incidunt quae.", + "ref_id": "xccdf_org.ssgproject.content_rule_779ead7777b6d367cdfe0ce6333135d3", + "references": [ + { + "href": "http://doyle-ruecker.test/edythe", + "label": "Axantur" + }, + { + "href": "http://williamson-mante.example/roslyn", + "label": "Arahad" + }, + { + "href": "http://hills.test/waldo", + "label": "Dior" + }, + { + "href": "http://bruen-armstrong.example/carlton.parisian", + "label": "Uldor" + }, + { + "href": "http://roob.example/zandra_mills", + "label": "Hyarmendacil" + } + ], + "remediation_available": false, + "rule_group_id": "53bddd4e-f2e3-456f-ad0f-426a19eda786", + "severity": "high", + "title": "Corrupti id dolor distinctio.", + "type": "rule", + "value_checks": null + }, + { + "description": "Est enim at. Sint suscipit qui. Voluptas nulla adipisci.", + "id": "c932b341-30e6-4e4f-84ac-d75c22daedee", + "identifier": { + "href": "http://glover-rowe.test/leonarda", + "label": "Galion" + }, + "precedence": 3880, + "rationale": "Eum et voluptates. Quae deleniti et. Nisi voluptatum molestiae.", + "ref_id": "xccdf_org.ssgproject.content_rule_b6cca00eef5a50d0fcc3c30d636c009f", + "references": [ + { + "href": "http://koelpin.test/keeley", + "label": "Ebor" + }, + { + "href": "http://yost-braun.test/cristobal.connelly", + "label": "Maglor" + }, + { + "href": "http://hammes-pfannerstill.example/debera", + "label": "Maedhros" + }, + { + "href": "http://dooley.test/brittni.kling", + "label": "Durin's Bane" + }, + { + "href": "http://marquardt.test/elsie", + "label": "Nurwë" + } + ], + "remediation_available": false, + "rule_group_id": "b3b5154b-2e56-46a1-b6ba-e6fcddba186d", + "severity": "low", + "title": "Provident est accusamus voluptatibus.", + "type": "rule", + "value_checks": null + }, + { + "description": "Expedita blanditiis hic. Aut est vitae. Consequatur cupiditate nemo.", + "id": "9ab41a76-aae1-4875-b0d9-1b35654b5436", + "identifier": { + "href": "http://becker-lindgren.example/marc.kulas", + "label": "Magor" + }, + "precedence": 3915, + "rationale": "Molestiae delectus perspiciatis. Ut qui fugit. Nulla magnam veniam.", + "ref_id": "xccdf_org.ssgproject.content_rule_ba9bd222c34ae276f18a95e9b6df85ef", + "references": [ + { + "href": "http://armstrong.example/thad_dietrich", + "label": "Baran" + }, + { + "href": "http://bailey.test/harry", + "label": "Leaflock" + }, + { + "href": "http://moen-koss.test/lacy_adams", + "label": "Otto Boffin" + }, + { + "href": "http://mosciski-pacocha.test/adina.mohr", + "label": "Snaga" + }, + { + "href": "http://keebler.test/anneliese", + "label": "Dinodas Brandybuck" + } + ], + "remediation_available": false, + "rule_group_id": "7bc8f6e4-b16f-4862-b746-30e2e883dadc", + "severity": "low", + "title": "Voluptatem eaque officiis veritatis.", + "type": "rule", + "value_checks": null + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/85d82063-b8f6-4e03-966c-01ab17f2a19c/rules?limit=10&offset=0&sort_by=precedence", + "last": "/api/compliance/v2/security_guides/85d82063-b8f6-4e03-966c-01ab17f2a19c/rules?limit=10&offset=20&sort_by=precedence", + "next": "/api/compliance/v2/security_guides/85d82063-b8f6-4e03-966c-01ab17f2a19c/rules?limit=10&offset=10&sort_by=precedence" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "precedence", + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/rule" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Rules" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Rules", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/rules/{rule_id}": { + "get": { + "description": "Retrieve a specific rule from a specific security guide.", + "operationId": "Rule", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "UUID or a ref_id with '.' characters replaced with '-'", + "in": "path", + "name": "rule_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Rule": { + "description": "", + "summary": "", + "value": { + "data": { + "description": "Veritatis facilis animi. Deleniti maxime eum. Perferendis modi praesentium.", + "id": "152c200a-90a8-45e1-9110-060732745a3b", + "identifier": { + "href": "http://langworth-crist.test/fidel.orn", + "label": "Valandil" + }, + "precedence": 1427, + "rationale": "Rerum necessitatibus distinctio. Possimus debitis architecto. Commodi et dolores.", + "ref_id": "xccdf_org.ssgproject.content_rule_394fc1e5c494c13371a68beb10452037", + "references": [ + { + "href": "http://macgyver.example/adolfo", + "label": "Aldor" + }, + { + "href": "http://runte-kihn.example/paige.kovacek", + "label": "Gorlim" + }, + { + "href": "http://kassulke.test/maurine", + "label": "Berylla Boffin" + }, + { + "href": "http://satterfield.example/coralie_trantow", + "label": "Tatië" + }, + { + "href": "http://ankunding.test/leontine_macejkovic", + "label": "Jessamine Boffin" + } + ], + "remediation_available": false, + "rule_group_id": "3fbf879a-c529-4bb0-a251-6023c5af116a", + "severity": "high", + "title": "Quisquam quia in ipsum.", + "type": "rule", + "value_checks": null + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/rule" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Rule" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Rule": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::Rule not found with ID 33a78ac2-cb10-4da2-913f-4878c3128bb2" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Rule", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/value_definitions": { + "get": { + "description": "Retrieve a list of the fields which can be edited within a profile.", + "operationId": "ValueDefinitions", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "title:asc", + "title:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Value Definitions are searchable using attributes `title` and `ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Value Definitions": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "default_value": "0.4412923014454486", + "description": "Non quibusdam fugiat. Quia itaque aut. Quia quisquam velit.", + "id": "0144b187-7082-42cd-a8c1-d69e989f0023", + "ref_id": "foo_value_703f790d-21d9-47e5-b218-aeb58feda781", + "title": "Enim voluptatem nisi maiores.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.24361512180720002", + "description": "Qui in fugit. Molestias asperiores error. Temporibus est ipsum.", + "id": "0b4bf39d-5029-4424-bbd8-ee6b5fa6829c", + "ref_id": "foo_value_40f50a85-b3ae-4fe7-8904-1b3061443606", + "title": "Ad ipsam qui vitae.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.0015693353714830716", + "description": "Laborum eum eum. Non quis vel. Quia dolor tempore.", + "id": "122d3788-5764-45b0-961f-49037a791109", + "ref_id": "foo_value_01849eb3-3d05-4f30-a82e-07fbdb1a8a18", + "title": "Ex culpa quisquam voluptas.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.923845517299785", + "description": "Nesciunt non repellat. Maxime iusto itaque. Cupiditate earum inventore.", + "id": "1790177b-3dfe-4568-bedc-13675ff36149", + "ref_id": "foo_value_3085b250-28d7-49f5-bb36-7f6df9e1d0c2", + "title": "Unde culpa est dolor.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.2819857708605198", + "description": "Sed sint eum. Praesentium porro tempora. Quas nostrum suscipit.", + "id": "2184a316-62f0-4386-9654-c84cf64c653c", + "ref_id": "foo_value_43d08c5a-9a90-49d3-8757-5642ed9468bd", + "title": "Vero adipisci at dolor.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.3281505693203356", + "description": "Ut similique praesentium. Eos minima repudiandae. Doloribus esse eveniet.", + "id": "58d141d2-424d-4aeb-930b-2e1746ecce9d", + "ref_id": "foo_value_fb3b9aa6-46d3-44c9-8445-3cb5413a32de", + "title": "Excepturi est velit et.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.6344440411128011", + "description": "Deserunt molestias voluptatum. Alias sit eum. Aut harum voluptatem.", + "id": "59a70d65-4b29-4f42-ad3a-789a7327c01f", + "ref_id": "foo_value_ef701b6a-aa67-4029-b9e9-f86f379b3e25", + "title": "Eum tenetur voluptates nobis.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.4692000812174909", + "description": "Magnam aut quo. Et unde distinctio. A ut dolorem.", + "id": "6782c485-b61e-41cc-a88d-e5a796334f4e", + "ref_id": "foo_value_a86375c8-41f7-4459-a030-4ca08d6d9987", + "title": "Et nihil libero in.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.7159694341190964", + "description": "Voluptas eum ad. Repellat ut rerum. Quos et dolorem.", + "id": "6d8aa609-b0fd-4d5e-88f8-851850c4e032", + "ref_id": "foo_value_e1ac4f39-9302-46e9-8373-f83c488fab84", + "title": "Ratione qui ad ea.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.8940229538931513", + "description": "Et ut quam. Qui ut sit. Corrupti voluptatibus officia.", + "id": "7b9f8c80-db8a-4a58-b9a0-c8844893dd17", + "ref_id": "foo_value_0bcf3fa2-a719-40c0-aa10-c36abbbef3f7", + "title": "Non molestiae in qui.", + "type": "value_definition", + "value_type": "number" + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/c484f239-e357-47cf-b71a-5318c33ab9a7/value_definitions?limit=10&offset=0", + "last": "/api/compliance/v2/security_guides/c484f239-e357-47cf-b71a-5318c33ab9a7/value_definitions?limit=10&offset=20", + "next": "/api/compliance/v2/security_guides/c484f239-e357-47cf-b71a-5318c33ab9a7/value_definitions?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + }, + "List of Value Definitions filtered by '(title=Sit aspernatur ea quod.)'": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "default_value": "0.4946603344230176", + "description": "Quasi et repudiandae. Blanditiis praesentium quo. Repudiandae alias quis.", + "id": "00bce4f8-5c39-489f-9d91-dbf9fef80b92", + "ref_id": "foo_value_714adaca-f594-4154-8348-4f79d82a862f", + "title": "Sit aspernatur ea quod.", + "type": "value_definition", + "value_type": "number" + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/82daa9a5-3b2a-48ae-bad9-ab32d4e1c935/value_definitions?filter=%28title%3D%22Sit+aspernatur+ea+quod.%22%29&limit=10&offset=0", + "last": "/api/compliance/v2/security_guides/82daa9a5-3b2a-48ae-bad9-ab32d4e1c935/value_definitions?filter=%28title%3D%22Sit+aspernatur+ea+quod.%22%29&limit=10&offset=0" + }, + "meta": { + "filter": "(title=\"Sit aspernatur ea quod.\")", + "limit": 10, + "offset": 0, + "total": 1 + } + } + }, + "List of Value Definitions sorted by \"title:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "default_value": "0.9213639674723846", + "description": "In adipisci tenetur. Quis consectetur minus. Expedita nihil consequatur.", + "id": "734be4ad-6fb8-4266-8f21-2c8f32d6d51c", + "ref_id": "foo_value_28a12b81-8231-4b29-a94d-a3fc5af44fb3", + "title": "Asperiores odit et facere.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.9810592055325207", + "description": "Accusamus maiores cum. Accusantium ratione explicabo. Odit fuga facilis.", + "id": "04d06218-6dd3-4e36-977b-c286a77c2a2e", + "ref_id": "foo_value_e6892e6d-f35c-4f74-98da-95fa828360f4", + "title": "Consequatur deserunt quo modi.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.6899939092037719", + "description": "Aut repellendus ut. Tempore dignissimos eligendi. Dolor facilis et.", + "id": "86af1497-9a18-4078-bcb5-8538158ff143", + "ref_id": "foo_value_1ded6319-73e1-485a-a6b3-ab3b6d9a5c04", + "title": "Corrupti laborum praesentium doloremque.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.20198143459335627", + "description": "Temporibus fugiat officia. Et doloremque eos. Quidem provident tenetur.", + "id": "7a7c6011-e408-4992-99ec-164691bc2324", + "ref_id": "foo_value_bbe38d5a-276b-406b-a751-b061a5297fd3", + "title": "Dolor deserunt sed est.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.028141406552997683", + "description": "Numquam natus quos. Quia accusantium et. Autem perspiciatis consequuntur.", + "id": "185da6ad-331d-4c65-9387-7abf4e240c0e", + "ref_id": "foo_value_69ca3fd1-bb6d-4596-a74a-1afd7c16f27a", + "title": "Dolor nihil odio asperiores.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.36162502651171646", + "description": "Ut consequatur qui. Eos ab inventore. Nihil ut vel.", + "id": "700a65e6-3836-4bec-b856-4aec7e19ac9c", + "ref_id": "foo_value_875177f7-cb46-46ab-accc-e057e0f78f02", + "title": "Dolorem ad rerum quas.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.7413582245498793", + "description": "Non consequuntur mollitia. Architecto laborum omnis. Non velit eius.", + "id": "c337074e-9239-40a9-9991-9356c19d8454", + "ref_id": "foo_value_482a20f4-0096-42d9-a26b-dafda2b3a424", + "title": "Dolores doloremque nisi est.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.24290272346421216", + "description": "Quia libero itaque. Vitae sed et. Et omnis dolor.", + "id": "16d91cd0-fe17-42ed-b366-73a147539ba2", + "ref_id": "foo_value_61be5f07-4e9c-4593-8957-e84c4f8a70ce", + "title": "Ducimus et sed ipsam.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.36950427644205264", + "description": "Qui ex sed. Nulla aut esse. Autem qui error.", + "id": "e1ef2ceb-c700-43b5-bae4-098072059fdc", + "ref_id": "foo_value_d22cd7a1-8c0a-4c43-8c61-c3d0b0b7aa7b", + "title": "Ducimus voluptates quae pariatur.", + "type": "value_definition", + "value_type": "number" + }, + { + "default_value": "0.49777502604910806", + "description": "Quas fuga omnis. Dolores vel expedita. Autem est debitis.", + "id": "5c7becca-1f71-4c73-918e-954f8e0fb5bf", + "ref_id": "foo_value_4d071a47-783b-44db-992a-9ed59adaa13f", + "title": "Eius voluptas illum suscipit.", + "type": "value_definition", + "value_type": "number" + } + ], + "links": { + "first": "/api/compliance/v2/security_guides/7657b710-2fcd-43d2-864d-9adde43d6664/value_definitions?limit=10&offset=0&sort_by=title", + "last": "/api/compliance/v2/security_guides/7657b710-2fcd-43d2-864d-9adde43d6664/value_definitions?limit=10&offset=20&sort_by=title", + "next": "/api/compliance/v2/security_guides/7657b710-2fcd-43d2-864d-9adde43d6664/value_definitions?limit=10&offset=10&sort_by=title" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "title", + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/value_definition" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Value Definitions" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Value Definitions", + "tags": [ + "Content" + ] + } + }, + "/security_guides/{security_guide_id}/value_definitions/{value_definition_id}": { + "get": { + "description": "Retrieve a specific value definition.", + "operationId": "ValueDefinition", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "security_guide_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "value_definition_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a Value Definition": { + "description": "", + "summary": "", + "value": { + "data": { + "default_value": "0.45874239642045966", + "description": "Ut ut minima. Fuga rerum totam. Non quia enim.", + "id": "cd45edac-8f3a-4c4a-8ff6-216f6b3d2625", + "ref_id": "foo_value_4b9c72ed-aef4-420b-b2f9-ab5567d3fbe6", + "title": "Minus dignissimos qui praesentium.", + "type": "value_definition", + "value_type": "number" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/value_definition" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a Value Definition" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing Value Definition": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::ValueDefinition not found with ID f9e06c27-f9e3-4cbe-95fc-45e529c06ff8" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a Value Definition", + "tags": [ + "Content" + ] + } + }, + "/systems": { + "get": { + "description": "List all systems that are accessible when you are logged into your account.", + "operationId": "Systems", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "An array of tags to narrow down the search results. In case the value contains symbols used for separators (`/` or `=`), they need to be encoded.
e.g.: `namespace/key=value`, `insights-client/selinux-config=SELINUX%3Denforcing`", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "display_name", + "os_major_version", + "os_minor_version", + "os_version", + "groups", + "display_name:asc", + "display_name:desc", + "os_major_version:asc", + "os_major_version:desc", + "os_minor_version:asc", + "os_minor_version:desc", + "os_version:asc", + "os_version:desc", + "groups:asc", + "groups:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `group_name`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Systems": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:07.725Z", + "display_name": "sporer.test", + "groups": [], + "id": "0271ebbf-7740-4611-8a46-539d12132155", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.725Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.725Z", + "tags": [ + { + "key": "program", + "namespace": "compressing", + "value": "cross-platform" + }, + { + "key": "program", + "namespace": "copying", + "value": "redundant" + }, + { + "key": "panel", + "namespace": "transmitting", + "value": "optical" + }, + { + "key": "card", + "namespace": "compressing", + "value": "1080p" + }, + { + "key": "microchip", + "namespace": "quantifying", + "value": "wireless" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.725Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.732Z", + "display_name": "mueller.test", + "groups": [], + "id": "07a586b7-e5e1-41c5-bc46-4812506ff1a3", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.732Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.732Z", + "tags": [ + { + "key": "monitor", + "namespace": "bypassing", + "value": "haptic" + }, + { + "key": "sensor", + "namespace": "indexing", + "value": "open-source" + }, + { + "key": "bandwidth", + "namespace": "overriding", + "value": "redundant" + }, + { + "key": "sensor", + "namespace": "synthesizing", + "value": "cross-platform" + }, + { + "key": "driver", + "namespace": "copying", + "value": "wireless" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.732Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.728Z", + "display_name": "hyatt-gerlach.test", + "groups": [], + "id": "0c6f445b-0652-4357-9e17-995499272d39", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.728Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.728Z", + "tags": [ + { + "key": "firewall", + "namespace": "calculating", + "value": "1080p" + }, + { + "key": "pixel", + "namespace": "indexing", + "value": "neural" + }, + { + "key": "firewall", + "namespace": "programming", + "value": "neural" + }, + { + "key": "system", + "namespace": "transmitting", + "value": "primary" + }, + { + "key": "program", + "namespace": "navigating", + "value": "auxiliary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.728Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.718Z", + "display_name": "bode.test", + "groups": [], + "id": "1d6e774a-9b95-4b11-ac5b-4e1ab9766869", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.718Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.718Z", + "tags": [ + { + "key": "bus", + "namespace": "navigating", + "value": "open-source" + }, + { + "key": "alarm", + "namespace": "indexing", + "value": "multi-byte" + }, + { + "key": "hard drive", + "namespace": "transmitting", + "value": "online" + }, + { + "key": "array", + "namespace": "copying", + "value": "virtual" + }, + { + "key": "array", + "namespace": "parsing", + "value": "neural" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.718Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.731Z", + "display_name": "anderson-kuvalis.example", + "groups": [], + "id": "1f1a5144-4eff-495e-9666-97bb031ce245", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.731Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.731Z", + "tags": [ + { + "key": "port", + "namespace": "connecting", + "value": "1080p" + }, + { + "key": "panel", + "namespace": "quantifying", + "value": "digital" + }, + { + "key": "feed", + "namespace": "transmitting", + "value": "neural" + }, + { + "key": "monitor", + "namespace": "calculating", + "value": "neural" + }, + { + "key": "monitor", + "namespace": "bypassing", + "value": "multi-byte" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.731Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.725Z", + "display_name": "miller.example", + "groups": [], + "id": "420e5f79-b9aa-4006-b5b2-d221fa90511a", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.725Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.725Z", + "tags": [ + { + "key": "bus", + "namespace": "calculating", + "value": "open-source" + }, + { + "key": "application", + "namespace": "copying", + "value": "virtual" + }, + { + "key": "hard drive", + "namespace": "parsing", + "value": "primary" + }, + { + "key": "monitor", + "namespace": "navigating", + "value": "cross-platform" + }, + { + "key": "capacitor", + "namespace": "overriding", + "value": "haptic" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.725Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.728Z", + "display_name": "schinner.example", + "groups": [], + "id": "5f7cbbf3-43df-4ab3-a442-e4c9e3a8d2a6", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.728Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.728Z", + "tags": [ + { + "key": "feed", + "namespace": "hacking", + "value": "mobile" + }, + { + "key": "panel", + "namespace": "indexing", + "value": "digital" + }, + { + "key": "bus", + "namespace": "synthesizing", + "value": "virtual" + }, + { + "key": "interface", + "namespace": "synthesizing", + "value": "mobile" + }, + { + "key": "program", + "namespace": "parsing", + "value": "digital" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.729Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.729Z", + "display_name": "pfeffer.example", + "groups": [], + "id": "64615c30-ae8a-4cdd-ba29-6926efeeff2e", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.729Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.729Z", + "tags": [ + { + "key": "panel", + "namespace": "overriding", + "value": "virtual" + }, + { + "key": "monitor", + "namespace": "overriding", + "value": "cross-platform" + }, + { + "key": "bus", + "namespace": "calculating", + "value": "digital" + }, + { + "key": "monitor", + "namespace": "backing up", + "value": "optical" + }, + { + "key": "pixel", + "namespace": "programming", + "value": "primary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.729Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.721Z", + "display_name": "brown-turner.example", + "groups": [], + "id": "6da4fb15-5cbc-45db-825b-deb358ac192a", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.721Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.721Z", + "tags": [ + { + "key": "panel", + "namespace": "bypassing", + "value": "online" + }, + { + "key": "feed", + "namespace": "backing up", + "value": "wireless" + }, + { + "key": "card", + "namespace": "compressing", + "value": "primary" + }, + { + "key": "driver", + "namespace": "calculating", + "value": "cross-platform" + }, + { + "key": "microchip", + "namespace": "overriding", + "value": "open-source" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.721Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.720Z", + "display_name": "kozey.test", + "groups": [], + "id": "74210eb2-16bb-4fbd-aa88-d552ffe061d7", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.720Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.720Z", + "tags": [ + { + "key": "firewall", + "namespace": "quantifying", + "value": "mobile" + }, + { + "key": "sensor", + "namespace": "transmitting", + "value": "bluetooth" + }, + { + "key": "panel", + "namespace": "parsing", + "value": "digital" + }, + { + "key": "bandwidth", + "namespace": "backing up", + "value": "open-source" + }, + { + "key": "circuit", + "namespace": "synthesizing", + "value": "redundant" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.720Z" + } + ], + "links": { + "first": "/api/compliance/v2/systems?limit=10&offset=0", + "last": "/api/compliance/v2/systems?limit=10&offset=20", + "next": "/api/compliance/v2/systems?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "tags": [], + "total": 25 + } + } + }, + "List of Systems filtered by \"(os_major_version=8)\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:07.795Z", + "display_name": "hackett-waters.example", + "groups": [], + "id": "04c8c010-6650-4e7a-be78-cf5a810a1539", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.795Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.795Z", + "tags": [ + { + "key": "monitor", + "namespace": "copying", + "value": "open-source" + }, + { + "key": "system", + "namespace": "calculating", + "value": "back-end" + }, + { + "key": "transmitter", + "namespace": "overriding", + "value": "virtual" + }, + { + "key": "firewall", + "namespace": "overriding", + "value": "neural" + }, + { + "key": "driver", + "namespace": "synthesizing", + "value": "open-source" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.795Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.796Z", + "display_name": "reinger.test", + "groups": [], + "id": "0ab6e4e0-bbce-4a11-a9a6-2c41ed319b37", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.796Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.796Z", + "tags": [ + { + "key": "transmitter", + "namespace": "bypassing", + "value": "haptic" + }, + { + "key": "sensor", + "namespace": "calculating", + "value": "optical" + }, + { + "key": "circuit", + "namespace": "overriding", + "value": "online" + }, + { + "key": "firewall", + "namespace": "indexing", + "value": "primary" + }, + { + "key": "port", + "namespace": "programming", + "value": "neural" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.796Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.794Z", + "display_name": "breitenberg-bernier.example", + "groups": [], + "id": "15b130ce-a993-4a02-8c54-7af618410efd", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.794Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.794Z", + "tags": [ + { + "key": "circuit", + "namespace": "hacking", + "value": "haptic" + }, + { + "key": "array", + "namespace": "hacking", + "value": "redundant" + }, + { + "key": "monitor", + "namespace": "copying", + "value": "auxiliary" + }, + { + "key": "interface", + "namespace": "transmitting", + "value": "primary" + }, + { + "key": "pixel", + "namespace": "navigating", + "value": "digital" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.794Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.806Z", + "display_name": "bruen.test", + "groups": [], + "id": "16448988-410f-4897-b595-7be8369d126c", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.806Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.806Z", + "tags": [ + { + "key": "card", + "namespace": "overriding", + "value": "wireless" + }, + { + "key": "hard drive", + "namespace": "compressing", + "value": "digital" + }, + { + "key": "bus", + "namespace": "synthesizing", + "value": "multi-byte" + }, + { + "key": "microchip", + "namespace": "navigating", + "value": "solid state" + }, + { + "key": "card", + "namespace": "backing up", + "value": "online" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.806Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.803Z", + "display_name": "hermiston-harber.example", + "groups": [], + "id": "1d10d7b1-d73b-4d69-85e0-7478ef62d3bc", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.803Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.803Z", + "tags": [ + { + "key": "port", + "namespace": "parsing", + "value": "back-end" + }, + { + "key": "program", + "namespace": "bypassing", + "value": "haptic" + }, + { + "key": "port", + "namespace": "parsing", + "value": "auxiliary" + }, + { + "key": "pixel", + "namespace": "calculating", + "value": "open-source" + }, + { + "key": "driver", + "namespace": "indexing", + "value": "optical" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.803Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.802Z", + "display_name": "okeefe.example", + "groups": [], + "id": "2f00f835-a252-443c-8ab9-bfc19cdac5f8", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.802Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.802Z", + "tags": [ + { + "key": "microchip", + "namespace": "synthesizing", + "value": "wireless" + }, + { + "key": "pixel", + "namespace": "overriding", + "value": "wireless" + }, + { + "key": "circuit", + "namespace": "backing up", + "value": "wireless" + }, + { + "key": "interface", + "namespace": "bypassing", + "value": "wireless" + }, + { + "key": "sensor", + "namespace": "transmitting", + "value": "haptic" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.802Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.806Z", + "display_name": "zboncak.test", + "groups": [], + "id": "2fd9ca52-53f3-4f6f-b180-60e9ab556b9d", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.806Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.806Z", + "tags": [ + { + "key": "transmitter", + "namespace": "bypassing", + "value": "wireless" + }, + { + "key": "microchip", + "namespace": "compressing", + "value": "online" + }, + { + "key": "pixel", + "namespace": "bypassing", + "value": "wireless" + }, + { + "key": "circuit", + "namespace": "quantifying", + "value": "primary" + }, + { + "key": "application", + "namespace": "calculating", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.806Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.811Z", + "display_name": "fritsch.test", + "groups": [], + "id": "407d7fd9-8f49-404d-99b5-2c5e75543c04", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.811Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.811Z", + "tags": [ + { + "key": "transmitter", + "namespace": "connecting", + "value": "virtual" + }, + { + "key": "application", + "namespace": "parsing", + "value": "solid state" + }, + { + "key": "feed", + "namespace": "connecting", + "value": "back-end" + }, + { + "key": "microchip", + "namespace": "calculating", + "value": "cross-platform" + }, + { + "key": "monitor", + "namespace": "copying", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.811Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.808Z", + "display_name": "leannon.example", + "groups": [], + "id": "4395c053-f0e1-4115-88be-74ce82fa9fbf", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.808Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.808Z", + "tags": [ + { + "key": "panel", + "namespace": "navigating", + "value": "wireless" + }, + { + "key": "feed", + "namespace": "generating", + "value": "wireless" + }, + { + "key": "program", + "namespace": "transmitting", + "value": "cross-platform" + }, + { + "key": "application", + "namespace": "synthesizing", + "value": "redundant" + }, + { + "key": "bandwidth", + "namespace": "indexing", + "value": "online" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.808Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.812Z", + "display_name": "abshire-collier.example", + "groups": [], + "id": "57919c4d-0901-49e9-89ac-e21028677f4e", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.812Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.812Z", + "tags": [ + { + "key": "monitor", + "namespace": "copying", + "value": "digital" + }, + { + "key": "firewall", + "namespace": "compressing", + "value": "mobile" + }, + { + "key": "capacitor", + "namespace": "transmitting", + "value": "bluetooth" + }, + { + "key": "firewall", + "namespace": "overriding", + "value": "1080p" + }, + { + "key": "bus", + "namespace": "transmitting", + "value": "digital" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.812Z" + } + ], + "links": { + "first": "/api/compliance/v2/systems?filter=%28os_major_version%3D8%29&limit=10&offset=0", + "last": "/api/compliance/v2/systems?filter=%28os_major_version%3D8%29&limit=10&offset=20", + "next": "/api/compliance/v2/systems?filter=%28os_major_version%3D8%29&limit=10&offset=10" + }, + "meta": { + "filter": "(os_major_version=8)", + "limit": 10, + "offset": 0, + "tags": [], + "total": 25 + } + } + }, + "List of Systems sorted by \"os_major_version:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "culled_timestamp": "2034-12-07T09:30:07.768Z", + "display_name": "hayes-turner.test", + "groups": [], + "id": "0489244f-58d3-4125-8b42-14ea67577566", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.768Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.768Z", + "tags": [ + { + "key": "sensor", + "namespace": "backing up", + "value": "cross-platform" + }, + { + "key": "program", + "namespace": "navigating", + "value": "auxiliary" + }, + { + "key": "firewall", + "namespace": "connecting", + "value": "open-source" + }, + { + "key": "circuit", + "namespace": "backing up", + "value": "virtual" + }, + { + "key": "matrix", + "namespace": "navigating", + "value": "online" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.768Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.761Z", + "display_name": "kuhlman-kunze.example", + "groups": [], + "id": "0f8844fc-3f2b-4c0a-b0d0-ae2024e7ca55", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.761Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.761Z", + "tags": [ + { + "key": "program", + "namespace": "hacking", + "value": "haptic" + }, + { + "key": "pixel", + "namespace": "bypassing", + "value": "cross-platform" + }, + { + "key": "port", + "namespace": "parsing", + "value": "back-end" + }, + { + "key": "transmitter", + "namespace": "hacking", + "value": "auxiliary" + }, + { + "key": "program", + "namespace": "parsing", + "value": "solid state" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.761Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.769Z", + "display_name": "corwin-stiedemann.test", + "groups": [], + "id": "1e69e6f7-7745-4b3c-8fcf-5eaaed0e4734", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.769Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.769Z", + "tags": [ + { + "key": "bus", + "namespace": "copying", + "value": "solid state" + }, + { + "key": "feed", + "namespace": "indexing", + "value": "solid state" + }, + { + "key": "alarm", + "namespace": "overriding", + "value": "back-end" + }, + { + "key": "bus", + "namespace": "synthesizing", + "value": "multi-byte" + }, + { + "key": "panel", + "namespace": "copying", + "value": "primary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.769Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.760Z", + "display_name": "hoeger-mosciski.test", + "groups": [], + "id": "3f1ea0ac-a60d-437b-a1e2-b7db8dbe9ab3", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.760Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.760Z", + "tags": [ + { + "key": "protocol", + "namespace": "transmitting", + "value": "haptic" + }, + { + "key": "protocol", + "namespace": "bypassing", + "value": "redundant" + }, + { + "key": "system", + "namespace": "programming", + "value": "optical" + }, + { + "key": "protocol", + "namespace": "synthesizing", + "value": "digital" + }, + { + "key": "hard drive", + "namespace": "backing up", + "value": "solid state" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.760Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.770Z", + "display_name": "olson.example", + "groups": [], + "id": "3fdacfff-05a4-433c-976d-5a1e6c348780", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.770Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.770Z", + "tags": [ + { + "key": "port", + "namespace": "overriding", + "value": "1080p" + }, + { + "key": "protocol", + "namespace": "overriding", + "value": "neural" + }, + { + "key": "program", + "namespace": "overriding", + "value": "multi-byte" + }, + { + "key": "monitor", + "namespace": "connecting", + "value": "haptic" + }, + { + "key": "pixel", + "namespace": "bypassing", + "value": "primary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.770Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.755Z", + "display_name": "dietrich.example", + "groups": [], + "id": "5162fada-3786-4e64-9276-d375602f9e0b", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.755Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.755Z", + "tags": [ + { + "key": "driver", + "namespace": "bypassing", + "value": "back-end" + }, + { + "key": "firewall", + "namespace": "connecting", + "value": "solid state" + }, + { + "key": "interface", + "namespace": "copying", + "value": "mobile" + }, + { + "key": "application", + "namespace": "copying", + "value": "cross-platform" + }, + { + "key": "port", + "namespace": "calculating", + "value": "back-end" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.755Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.765Z", + "display_name": "hintz-dooley.example", + "groups": [], + "id": "54f60dad-c916-422b-b601-c9b14e97c7db", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.765Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.765Z", + "tags": [ + { + "key": "microchip", + "namespace": "calculating", + "value": "1080p" + }, + { + "key": "hard drive", + "namespace": "hacking", + "value": "mobile" + }, + { + "key": "capacitor", + "namespace": "connecting", + "value": "optical" + }, + { + "key": "protocol", + "namespace": "bypassing", + "value": "haptic" + }, + { + "key": "feed", + "namespace": "programming", + "value": "auxiliary" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.766Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.773Z", + "display_name": "conn.test", + "groups": [], + "id": "5aad8476-0a1d-4814-9b42-24e5c8b319b1", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.773Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.773Z", + "tags": [ + { + "key": "bandwidth", + "namespace": "backing up", + "value": "back-end" + }, + { + "key": "card", + "namespace": "parsing", + "value": "optical" + }, + { + "key": "hard drive", + "namespace": "quantifying", + "value": "digital" + }, + { + "key": "bus", + "namespace": "quantifying", + "value": "virtual" + }, + { + "key": "matrix", + "namespace": "hacking", + "value": "bluetooth" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.773Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.772Z", + "display_name": "connelly.example", + "groups": [], + "id": "61e2f929-665d-46f3-929b-5e8cc18c3637", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.772Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.772Z", + "tags": [ + { + "key": "protocol", + "namespace": "bypassing", + "value": "cross-platform" + }, + { + "key": "microchip", + "namespace": "overriding", + "value": "online" + }, + { + "key": "application", + "namespace": "connecting", + "value": "auxiliary" + }, + { + "key": "panel", + "namespace": "bypassing", + "value": "open-source" + }, + { + "key": "panel", + "namespace": "hacking", + "value": "cross-platform" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.772Z" + }, + { + "culled_timestamp": "2034-12-07T09:30:07.777Z", + "display_name": "toy.test", + "groups": [], + "id": "77e9bc0a-6131-4db0-ac9a-58231786f951", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.777Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.777Z", + "tags": [ + { + "key": "array", + "namespace": "synthesizing", + "value": "haptic" + }, + { + "key": "card", + "namespace": "overriding", + "value": "mobile" + }, + { + "key": "card", + "namespace": "copying", + "value": "1080p" + }, + { + "key": "driver", + "namespace": "quantifying", + "value": "cross-platform" + }, + { + "key": "feed", + "namespace": "quantifying", + "value": "virtual" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.777Z" + } + ], + "links": { + "first": "/api/compliance/v2/systems?limit=10&offset=0&sort_by=os_major_version", + "last": "/api/compliance/v2/systems?limit=10&offset=20&sort_by=os_major_version", + "next": "/api/compliance/v2/systems?limit=10&offset=10&sort_by=os_major_version" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "os_major_version", + "tags": [], + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/system" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Systems" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Systems", + "tags": [ + "Systems" + ] + } + }, + "/systems/os_versions": { + "get": { + "deprecated": true, + "description": "This feature is exclusively used by the frontend.", + "operationId": "SystemsOS", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_version`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `never_reported`, `group_name`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of available OS versions": { + "description": "", + "summary": "", + "value": [ + "8.0" + ] + } + }, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "description": "Lists available OS versions" + } + }, + "summary": "Request the list of available OS versions", + "tags": [ + "Systems" + ] + } + }, + "/systems/{system_id}": { + "get": { + "description": "Get information about one specific system.", + "operationId": "System", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "system_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "Returns a System": { + "description": "", + "summary": "", + "value": { + "data": { + "culled_timestamp": "2034-12-07T09:30:07.938Z", + "display_name": "hyatt-ondricka.test", + "groups": [], + "id": "f24dfc9f-d2a2-4a3e-9be5-9a6bd6267e86", + "insights_id": null, + "os_major_version": 8, + "os_minor_version": 0, + "policies": [], + "stale_timestamp": "2034-11-23T09:30:07.938Z", + "stale_warning_timestamp": "2034-11-30T09:30:07.938Z", + "tags": [ + { + "key": "hard drive", + "namespace": "overriding", + "value": "mobile" + }, + { + "key": "capacitor", + "namespace": "copying", + "value": "mobile" + }, + { + "key": "panel", + "namespace": "indexing", + "value": "online" + }, + { + "key": "hard drive", + "namespace": "copying", + "value": "haptic" + }, + { + "key": "bus", + "namespace": "bypassing", + "value": "redundant" + } + ], + "type": "system", + "updated": "2024-11-23T09:30:07.938Z" + } + } + } + }, + "schema": { + "properties": { + "data": { + "properties": { + "schema": { + "$ref": "#/components/schemas/system" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Returns a System" + }, + "404": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting a non-existing System": { + "description": "", + "summary": "", + "value": { + "errors": [ + "V2::System not found with ID 64715ad4-0c3e-4b76-af30-86907d871e62" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Not Found" + } + }, + "summary": "Request a System", + "tags": [ + "Systems" + ] + } + }, + "/systems/{system_id}/policies": { + "get": { + "description": "List all policies assigned to a single system.", + "operationId": "SystemsPolicies", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "business_objective", + "compliance_threshold", + "title:asc", + "title:desc", + "business_objective:asc", + "business_objective:desc", + "compliance_threshold:asc", + "compliance_threshold:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Policies are searchable using attributes `title` and `os_minor_version`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "system_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Policies under a System": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "business_objective": null, + "compliance_threshold": 78, + "description": "Pariatur laudantium eligendi. Molestiae voluptas quia. Deserunt facere perferendis.", + "id": "0639612b-1f8c-4396-889f-18197406450c", + "os_major_version": 7, + "profile_title": "Alias at optio est.", + "ref_id": "xccdf_org.ssgproject.content_profile_48de53c4305ab431e108f51e505d33c8", + "title": "Aliquam qui ut amet.", + "total_system_count": 1, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 23, + "description": "Nemo ut hic. Et asperiores sequi. Et sit eos.", + "id": "17d9914b-c3dd-458c-9d4c-3971a6e1fe4e", + "os_major_version": 7, + "profile_title": "Est voluptas iusto eos.", + "ref_id": "xccdf_org.ssgproject.content_profile_8c5df7b2c3d9442d6b06883ff2d29644", + "title": "Ipsam tempora repudiandae dolorem.", + "total_system_count": 1, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 16, + "description": "Hic tenetur eos. Iste similique eligendi. Non dolorem rerum.", + "id": "1ddc4560-c490-4fd0-b955-c28031c8910b", + "os_major_version": 7, + "profile_title": "Quisquam natus omnis soluta.", + "ref_id": "xccdf_org.ssgproject.content_profile_ef684141e79f75e419b64193a5aec922", + "title": "Et ut eaque soluta.", + "total_system_count": 1, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 56, + "description": "Tempora sit a. Aut omnis quis. Quos eius odio.", + "id": "3b9f97a2-fe58-4de2-beeb-000a92462a90", + "os_major_version": 7, + "profile_title": "Fugiat ipsum distinctio aut.", + "ref_id": "xccdf_org.ssgproject.content_profile_eea1751a1fb9674dff6442656a41fc3d", + "title": "Dolores et ullam enim.", + "total_system_count": 1, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 53, + "description": "Voluptatem amet vel. Aut sit sequi. Dicta nobis aut.", + "id": "41f5b005-ccab-4765-b7dd-2695cb11132e", + "os_major_version": 7, + "profile_title": "Qui explicabo quia alias.", + "ref_id": "xccdf_org.ssgproject.content_profile_f47058db30bd511d6aac9c67848869fa", + "title": "Voluptatem deleniti qui et.", + "total_system_count": 1, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 13, + "description": "Repudiandae tempore molestias. Enim voluptas ipsam. Repellat unde quia.", + "id": "5c60ddc6-93ca-4ec2-9e3d-4787cd2e021e", + "os_major_version": 7, + "profile_title": "Enim itaque ut suscipit.", + "ref_id": "xccdf_org.ssgproject.content_profile_3764e8cd58e4e503c9d1b32030a1aacf", + "title": "Magni dolores quo inventore.", + "total_system_count": 1, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 56, + "description": "Dolore omnis fuga. Esse fugiat accusantium. Aperiam ducimus saepe.", + "id": "764f5ce5-7b4b-4052-b520-dd475e26ab54", + "os_major_version": 7, + "profile_title": "Non non et dolores.", + "ref_id": "xccdf_org.ssgproject.content_profile_d9f3ac7b815fa6bb156902ba9ec00cb0", + "title": "Ea omnis id illo.", + "total_system_count": 1, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 81, + "description": "Velit aliquam ullam. Sunt aliquam quaerat. Est ex quia.", + "id": "7d404832-fa14-4df8-86f3-961b987f3680", + "os_major_version": 7, + "profile_title": "Consequatur sit tempora facilis.", + "ref_id": "xccdf_org.ssgproject.content_profile_2471640c6bef4ffeaf50dad5b9f68f8d", + "title": "Voluptates facere nemo debitis.", + "total_system_count": 1, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 51, + "description": "Nemo quisquam et. Omnis dignissimos corporis. Laudantium in cum.", + "id": "82c07876-0f80-4c09-9320-a067548574ac", + "os_major_version": 7, + "profile_title": "A eos nihil blanditiis.", + "ref_id": "xccdf_org.ssgproject.content_profile_24920d73ce51d1ed1c39abc5e3d5ba88", + "title": "Quidem eius provident aliquam.", + "total_system_count": 1, + "type": "policy" + }, + { + "business_objective": null, + "compliance_threshold": 25, + "description": "Ullam aperiam nihil. Voluptate autem minus. Dolore illo ab.", + "id": "8fe764d7-0d8a-4d34-9bdb-4e52b20b473d", + "os_major_version": 7, + "profile_title": "Eum harum ut natus.", + "ref_id": "xccdf_org.ssgproject.content_profile_d4d1ede695a82b7af1d5217314d66986", + "title": "Voluptas ut perferendis dolorem.", + "total_system_count": 1, + "type": "policy" + } + ], + "links": { + "first": "/api/compliance/v2/systems/88aab99e-b835-4eae-b7ec-a6071846802d/policies?limit=10&offset=0", + "last": "/api/compliance/v2/systems/88aab99e-b835-4eae-b7ec-a6071846802d/policies?limit=10&offset=20", + "next": "/api/compliance/v2/systems/88aab99e-b835-4eae-b7ec-a6071846802d/policies?limit=10&offset=10" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 25 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/policy" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Policies" + } + }, + "summary": "Request Policies assigned to a System", + "tags": [ + "Systems" + ] + } + }, + "/systems/{system_id}/reports": { + "get": { + "description": "Retrieve a list of reports for a specific system.", + "operationId": "SystemReports", + "parameters": [ + { + "description": "For internal use only", + "in": "header", + "name": "X-RH-IDENTITY", + "schema": { + "type": "string" + } + }, + { + "description": "Number of items to return per page", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "description": "Offset of first item of paginated response", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Indicates whether to return only resource IDs.", + "in": "query", + "name": "ids_only", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "items": { + "enum": [ + "title", + "business_objective", + "compliance_threshold", + "percent_compliant", + "title:asc", + "title:desc", + "business_objective:asc", + "business_objective:desc", + "compliance_threshold:asc", + "compliance_threshold:desc", + "percent_compliant:asc", + "percent_compliant:desc" + ] + }, + "type": "array" + } + }, + { + "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Reports are searchable using attributes `title`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "system_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "examples": { + "List of Reports": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "all_systems_exposed": false, + "business_objective": "hard drive", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Culpa tenetur quae. Omnis non dolores. Eum sit qui.", + "id": "4a2c3f0d-c00f-4c14-a4b2-6ca3cfafc00e", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Ut deleniti officiis unde.", + "ref_id": "xccdf_org.ssgproject.content_profile_ffb38d0dcd2c01cd8297f33ddec00778", + "reported_system_count": 0, + "title": "Suscipit quos sed aut.", + "type": "report", + "unsupported_system_count": 0 + }, + { + "all_systems_exposed": false, + "business_objective": "pixel", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Nihil possimus dolorum. Aliquid nulla consequatur. Fugit et voluptate.", + "id": "4b26fb0c-25db-4d5a-9db7-4d5c50f66728", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Non officiis qui excepturi.", + "ref_id": "xccdf_org.ssgproject.content_profile_94d2a641e8c828657894918ca5c9199f", + "reported_system_count": 0, + "title": "Ipsam magnam hic et.", + "type": "report", + "unsupported_system_count": 0 + }, + { + "all_systems_exposed": false, + "business_objective": "sensor", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Nisi eaque possimus. Omnis maxime voluptate. Alias nemo voluptatem.", + "id": "5d1f589b-a55e-41c8-8a1b-fdcbd78973a6", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Exercitationem sed labore repellat.", + "ref_id": "xccdf_org.ssgproject.content_profile_3d17d4f07d684e9c11e2bb122399b97f", + "reported_system_count": 0, + "title": "Perspiciatis impedit totam debitis.", + "type": "report", + "unsupported_system_count": 0 + }, + { + "all_systems_exposed": false, + "business_objective": "card", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Dolorum expedita quia. Voluptatem at illo. Qui alias voluptatem.", + "id": "d46e65a1-ba80-42f8-be8a-c6b39641392a", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Sit totam iusto culpa.", + "ref_id": "xccdf_org.ssgproject.content_profile_0d61e557533e8042018c6f5eddd92786", + "reported_system_count": 0, + "title": "Minus saepe autem voluptatem.", + "type": "report", + "unsupported_system_count": 0 + }, + { + "all_systems_exposed": false, + "business_objective": "port", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Rerum nemo voluptatem. Non enim fuga. Et nesciunt modi.", + "id": "e65f848c-a214-4bee-89a0-c257fa36cc28", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Velit odio animi necessitatibus.", + "ref_id": "xccdf_org.ssgproject.content_profile_147d41d17f78e89a8334b07b75adcc14", + "reported_system_count": 0, + "title": "Ea quia optio magni.", + "type": "report", + "unsupported_system_count": 0 + } + ], + "links": { + "first": "/api/compliance/v2/systems/a28c2287-04ed-4c55-9650-8dac1baff4da/reports?limit=10&offset=0", + "last": "/api/compliance/v2/systems/a28c2287-04ed-4c55-9650-8dac1baff4da/reports?limit=10&offset=0" + }, + "meta": { + "limit": 10, + "offset": 0, + "total": 5 + } + } + }, + "List of Reports sorted by \"title:asc\"": { + "description": "", + "summary": "", + "value": { + "data": [ + { + "all_systems_exposed": false, + "business_objective": "feed", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Ipsam et et. Soluta ut reiciendis. Omnis vitae nostrum.", + "id": "06bd9c9e-5697-477e-a87d-5d5571312185", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Porro omnis in est.", + "ref_id": "xccdf_org.ssgproject.content_profile_ceaaa24e9810d0b547a19fb51b73e62d", + "reported_system_count": 0, + "title": "Cum repellendus aut vero.", + "type": "report", + "unsupported_system_count": 0 + }, + { + "all_systems_exposed": false, + "business_objective": "array", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Non veritatis delectus. Fuga nesciunt eos. Quia aperiam atque.", + "id": "8af5bb4a-0494-476a-8757-7103a3e4027a", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Soluta ea sed debitis.", + "ref_id": "xccdf_org.ssgproject.content_profile_1afd2590ccede1569babd7cd23902d04", + "reported_system_count": 0, + "title": "Eius amet nihil consequatur.", + "type": "report", + "unsupported_system_count": 0 + }, + { + "all_systems_exposed": false, + "business_objective": "driver", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Sed eum et. Cupiditate non neque. Dolore consequuntur id.", + "id": "0bdc972f-60b1-47dd-88ea-2af5de2ad119", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Iure quam nisi et.", + "ref_id": "xccdf_org.ssgproject.content_profile_9ad183716bc3ad6b3e217ecaea45e265", + "reported_system_count": 0, + "title": "Non ex et odit.", + "type": "report", + "unsupported_system_count": 0 + }, + { + "all_systems_exposed": false, + "business_objective": "array", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Inventore rem quo. Molestiae officiis est. Assumenda illum sint.", + "id": "15633180-2a40-4f01-8f5e-802214772178", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Saepe mollitia doloribus aliquid.", + "ref_id": "xccdf_org.ssgproject.content_profile_0f91e41b99d1799b81e88b626e05bee6", + "reported_system_count": 0, + "title": "Qui earum velit exercitationem.", + "type": "report", + "unsupported_system_count": 0 + }, + { + "all_systems_exposed": false, + "business_objective": "alarm", + "compliance_threshold": 90, + "compliant_system_count": 0, + "description": "Nam blanditiis nesciunt. Pariatur delectus veniam. Voluptatem recusandae facere.", + "id": "91249caa-f082-4e37-a6a3-a649cedd1881", + "os_major_version": 8, + "percent_compliant": 0, + "profile_title": "Perspiciatis ipsam saepe doloribus.", + "ref_id": "xccdf_org.ssgproject.content_profile_8a6dbc681f51105cedf7d0eb1d5996e9", + "reported_system_count": 0, + "title": "Quia repellendus sapiente quod.", + "type": "report", + "unsupported_system_count": 0 + } + ], + "links": { + "first": "/api/compliance/v2/systems/b0720b36-0186-49c1-b3e6-a845ba7f83af/reports?limit=10&offset=0&sort_by=title", + "last": "/api/compliance/v2/systems/b0720b36-0186-49c1-b3e6-a845ba7f83af/reports?limit=10&offset=0&sort_by=title" + }, + "meta": { + "limit": 10, + "offset": 0, + "sort_by": "title", + "total": 5 + } + } + } + }, + "schema": { + "properties": { + "data": { + "items": { + "properties": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + }, + "description": "Lists Reports" + }, + "422": { + "content": { + "application/vnd.api+json": { + "examples": { + "Description of an error when requesting higher limit than supported": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Invalid parameter: limit must be less than or equal to 100" + ] + } + }, + "Description of an error when sorting by incorrect parameter": { + "description": "", + "summary": "", + "value": { + "errors": [ + "Result cannot be sorted by the 'description' column." + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/errors" + } + } + }, + "description": "Returns with Unprocessable Content" + } + }, + "summary": "Request Reports", + "tags": [ + "Reports" + ] + } + } + }, + "servers": [ + { + "url": "https://{defaultHost}/api/compliance/v2", + "variables": { + "defaultHost": { + "default": "console.redhat.com" + } + } + } + ] + } +} \ No newline at end of file diff --git a/packages/common/config/apis/hcc-insights/integrations/content.json b/packages/common/config/apis/hcc-insights/integrations/content.json index 5a6a732d..fa54aa86 100644 --- a/packages/common/config/apis/hcc-insights/integrations/content.json +++ b/packages/common/config/apis/hcc-insights/integrations/content.json @@ -103,11 +103,7 @@ "Endpoint": { "properties": { "created": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" }, @@ -141,11 +137,7 @@ "type": "string" }, "properties": { - "allOf": [ - { - "$ref": "#/components/schemas/EndpointProperties" - } - ], + "$ref": "#/components/schemas/EndpointProperties", "oneOf": [ { "$ref": "#/components/schemas/CamelProperties" @@ -178,11 +170,7 @@ "$ref": "#/components/schemas/EndpointType" }, "updated": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" } @@ -291,7 +279,9 @@ "type": "string" }, "LocalDateTime": { - "example": "2022-03-10T12:15:50", + "examples": [ + "2022-03-10T12:15:50" + ], "format": "date-time", "type": "string" }, @@ -310,11 +300,7 @@ "NotificationHistory": { "properties": { "created": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" }, @@ -453,7 +439,7 @@ "title": "Integrations", "version": "v1.0" }, - "openapi": "3.0.3", + "openapi": "3.1.0", "paths": { "/endpoints": { "get": { @@ -751,7 +737,8 @@ "uniqueItems": true } } - } + }, + "required": true }, "responses": { "204": { @@ -917,7 +904,6 @@ }, "/endpoints/{id}/history": { "get": { - "description": "Get Endpoint History", "operationId": "EndpointResource$V1_getEndpointHistory", "parameters": [ { @@ -996,6 +982,7 @@ "description": "OK" } }, + "summary": "Get Endpoint History", "tags": [ "V 1" ] @@ -1060,7 +1047,8 @@ "$ref": "#/components/schemas/EndpointTestRequest" } } - } + }, + "required": true }, "responses": { "204": { diff --git a/packages/common/config/apis/hcc-insights/notifications/content.json b/packages/common/config/apis/hcc-insights/notifications/content.json index 7873000d..813d42a5 100644 --- a/packages/common/config/apis/hcc-insights/notifications/content.json +++ b/packages/common/config/apis/hcc-insights/notifications/content.json @@ -9,11 +9,7 @@ "$ref": "#/components/schemas/UUID" }, "created": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" }, @@ -21,11 +17,7 @@ "type": "string" }, "id": { - "allOf": [ - { - "$ref": "#/components/schemas/UUID" - } - ], + "$ref": "#/components/schemas/UUID", "readOnly": true, "type": "string" }, @@ -35,11 +27,7 @@ "type": "string" }, "updated": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" } @@ -73,11 +61,7 @@ "$ref": "#/components/schemas/UUID" }, "created": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" }, @@ -90,20 +74,12 @@ "type": "string" }, "id": { - "allOf": [ - { - "$ref": "#/components/schemas/UUID" - } - ], + "$ref": "#/components/schemas/UUID", "readOnly": true, "type": "string" }, "updated": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" } @@ -117,11 +93,7 @@ "BehaviorGroupAction": { "properties": { "created": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" }, @@ -152,11 +124,7 @@ "Bundle": { "properties": { "created": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" }, @@ -164,11 +132,7 @@ "type": "string" }, "id": { - "allOf": [ - { - "$ref": "#/components/schemas/UUID" - } - ], + "$ref": "#/components/schemas/UUID", "readOnly": true, "type": "string" }, @@ -178,11 +142,7 @@ "type": "string" }, "updated": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" } @@ -306,11 +266,7 @@ "Endpoint": { "properties": { "created": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" }, @@ -345,11 +301,7 @@ "$ref": "#/components/schemas/EndpointType" }, "updated": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" } @@ -484,11 +436,7 @@ "type": "string" }, "id": { - "allOf": [ - { - "$ref": "#/components/schemas/UUID" - } - ], + "$ref": "#/components/schemas/UUID", "readOnly": true, "type": "string" }, @@ -520,11 +468,7 @@ "EventTypeBehavior": { "properties": { "created": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalDateTime" - } - ], + "$ref": "#/components/schemas/LocalDateTime", "readOnly": true, "type": "string" }, @@ -578,17 +522,23 @@ "type": "object" }, "LocalDate": { - "example": "2022-03-10", + "examples": [ + "2022-03-10" + ], "format": "date", "type": "string" }, "LocalDateTime": { - "example": "2022-03-10T12:15:50", + "examples": [ + "2022-03-10T12:15:50" + ], "format": "date-time", "type": "string" }, "LocalTime": { - "example": "13:45:30.123456789", + "examples": [ + "13:45:30.123456789" + ], "externalDocs": { "description": "As defined by 'partial-time' in RFC3339", "url": "https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6" @@ -745,7 +695,7 @@ "title": "Notifications", "version": "v1.0" }, - "openapi": "3.0.3", + "openapi": "3.1.0", "paths": { "/notifications/behaviorGroups": { "post": { @@ -845,7 +795,8 @@ "type": "array" } } - } + }, + "required": true }, "responses": { "200": { @@ -1231,7 +1182,8 @@ "$ref": "#/components/schemas/UpdateNotificationDrawerStatus" } } - } + }, + "required": true }, "responses": { "200": { @@ -1486,7 +1438,8 @@ "uniqueItems": true } } - } + }, + "required": true }, "responses": { "200": { @@ -1561,7 +1514,8 @@ "uniqueItems": true } } - } + }, + "required": true }, "responses": { "200": { @@ -1863,7 +1817,8 @@ "$ref": "#/components/schemas/LocalTime" } } - } + }, + "required": true }, "responses": { "204": { diff --git a/packages/discovery/Discovery.yml b/packages/discovery/Discovery.yml index 59ec5996..c88d378f 100644 --- a/packages/discovery/Discovery.yml +++ b/packages/discovery/Discovery.yml @@ -34,8 +34,8 @@ apis: tags: - ansible - automation - - id: compliance - name: Compliance + - id: compliance_v1 + name: Compliance V1 description: Assess, monitor, and report on the security-policy compliance of RHEL systems url: https://console.redhat.com/api/compliance/v1/openapi.json serverUrl: https://console.redhat.com @@ -46,6 +46,18 @@ apis: - observe - rhel - security + - id: compliance_v2 + name: Compliance V2 + description: Assess, monitor, and report on the security-policy compliance of RHEL systems + url: https://console.redhat.com/api/compliance/v2/openapi.json + serverUrl: https://console.redhat.com + apiType: openapi-v3 + icon: insights + tags: + - insights + - observe + - rhel + - security - id: cost-management name: Cost Management description: The API for Project Koku and OpenShift cost management