feat(containeranalysis): update the api

#### containeranalysis:v1alpha1 The following keys were added: - schemas.CisBenchmark (Total Keys: 5) - schemas.ComplianceNote (Total Keys: 9) - schemas.ComplianceOccurrence (Total Keys: 5) - schemas.ComplianceVersion (Total Keys: 4) - schemas.NonCompliantFile (Total Keys: 5) - schemas.Note.properties.compliance.$ref (Total Keys: 1) - schemas.Occurrence.properties.compliance.$ref (Total Keys: 1)
googleapis · Jun 10, 2021 · 9a1c70b · 9a1c70b
1 parent 975d3e2
commit 9a1c70b
Show file tree

Hide file tree

Showing 7 changed files with 451 additions and 10 deletions.
diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
@@ -149,6 +149,23 @@ <h3>Method Details</h3>
       &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
     },
   },
+  &quot;compliance&quot;: { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check.
+    &quot;cisBenchmark&quot;: { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future.
+      &quot;profileLevel&quot;: 42, # The profile level of this CIS benchmark check.
+      &quot;severity&quot;: &quot;A String&quot;, # The severity level of this CIS benchmark check.
+    },
+    &quot;description&quot;: &quot;A String&quot;, # A description about this compliance check.
+    &quot;rationale&quot;: &quot;A String&quot;, # A rationale for the existence of this compliance check.
+    &quot;remediation&quot;: &quot;A String&quot;, # A description of remediation steps if the compliance check fails.
+    &quot;scanInstructions&quot;: &quot;A String&quot;, # Serialized scan instructions with a predefined format.
+    &quot;title&quot;: &quot;A String&quot;, # The title that identifies this compliance check.
+    &quot;version&quot;: [ # The OS and config versions the benchmark applies to.
+      { # Describes the CIS benchmark version that is applicable to a given OS and os version.
+        &quot;cpeUri&quot;: &quot;A String&quot;, # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+        &quot;version&quot;: &quot;A String&quot;, # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+      },
+    ],
+  },
   &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
   &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
     &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
@@ -287,6 +304,23 @@ <h3>Method Details</h3>
       &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
     },
   },
+  &quot;compliance&quot;: { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check.
+    &quot;cisBenchmark&quot;: { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future.
+      &quot;profileLevel&quot;: 42, # The profile level of this CIS benchmark check.
+      &quot;severity&quot;: &quot;A String&quot;, # The severity level of this CIS benchmark check.
+    },
+    &quot;description&quot;: &quot;A String&quot;, # A description about this compliance check.
+    &quot;rationale&quot;: &quot;A String&quot;, # A rationale for the existence of this compliance check.
+    &quot;remediation&quot;: &quot;A String&quot;, # A description of remediation steps if the compliance check fails.
+    &quot;scanInstructions&quot;: &quot;A String&quot;, # Serialized scan instructions with a predefined format.
+    &quot;title&quot;: &quot;A String&quot;, # The title that identifies this compliance check.
+    &quot;version&quot;: [ # The OS and config versions the benchmark applies to.
+      { # Describes the CIS benchmark version that is applicable to a given OS and os version.
+        &quot;cpeUri&quot;: &quot;A String&quot;, # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+        &quot;version&quot;: &quot;A String&quot;, # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+      },
+    ],
+  },
   &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
   &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
     &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
@@ -448,6 +482,23 @@ <h3>Method Details</h3>
       &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
     },
   },
+  &quot;compliance&quot;: { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check.
+    &quot;cisBenchmark&quot;: { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future.
+      &quot;profileLevel&quot;: 42, # The profile level of this CIS benchmark check.
+      &quot;severity&quot;: &quot;A String&quot;, # The severity level of this CIS benchmark check.
+    },
+    &quot;description&quot;: &quot;A String&quot;, # A description about this compliance check.
+    &quot;rationale&quot;: &quot;A String&quot;, # A rationale for the existence of this compliance check.
+    &quot;remediation&quot;: &quot;A String&quot;, # A description of remediation steps if the compliance check fails.
+    &quot;scanInstructions&quot;: &quot;A String&quot;, # Serialized scan instructions with a predefined format.
+    &quot;title&quot;: &quot;A String&quot;, # The title that identifies this compliance check.
+    &quot;version&quot;: [ # The OS and config versions the benchmark applies to.
+      { # Describes the CIS benchmark version that is applicable to a given OS and os version.
+        &quot;cpeUri&quot;: &quot;A String&quot;, # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+        &quot;version&quot;: &quot;A String&quot;, # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+      },
+    ],
+  },
   &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
   &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
     &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
@@ -641,6 +692,23 @@ <h3>Method Details</h3>
           &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
         },
       },
+      &quot;compliance&quot;: { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check.
+        &quot;cisBenchmark&quot;: { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future.
+          &quot;profileLevel&quot;: 42, # The profile level of this CIS benchmark check.
+          &quot;severity&quot;: &quot;A String&quot;, # The severity level of this CIS benchmark check.
+        },
+        &quot;description&quot;: &quot;A String&quot;, # A description about this compliance check.
+        &quot;rationale&quot;: &quot;A String&quot;, # A rationale for the existence of this compliance check.
+        &quot;remediation&quot;: &quot;A String&quot;, # A description of remediation steps if the compliance check fails.
+        &quot;scanInstructions&quot;: &quot;A String&quot;, # Serialized scan instructions with a predefined format.
+        &quot;title&quot;: &quot;A String&quot;, # The title that identifies this compliance check.
+        &quot;version&quot;: [ # The OS and config versions the benchmark applies to.
+          { # Describes the CIS benchmark version that is applicable to a given OS and os version.
+            &quot;cpeUri&quot;: &quot;A String&quot;, # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+            &quot;version&quot;: &quot;A String&quot;, # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+          },
+        ],
+      },
       &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
       &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
         &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
@@ -795,6 +863,23 @@ <h3>Method Details</h3>
       &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
     },
   },
+  &quot;compliance&quot;: { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check.
+    &quot;cisBenchmark&quot;: { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future.
+      &quot;profileLevel&quot;: 42, # The profile level of this CIS benchmark check.
+      &quot;severity&quot;: &quot;A String&quot;, # The severity level of this CIS benchmark check.
+    },
+    &quot;description&quot;: &quot;A String&quot;, # A description about this compliance check.
+    &quot;rationale&quot;: &quot;A String&quot;, # A rationale for the existence of this compliance check.
+    &quot;remediation&quot;: &quot;A String&quot;, # A description of remediation steps if the compliance check fails.
+    &quot;scanInstructions&quot;: &quot;A String&quot;, # Serialized scan instructions with a predefined format.
+    &quot;title&quot;: &quot;A String&quot;, # The title that identifies this compliance check.
+    &quot;version&quot;: [ # The OS and config versions the benchmark applies to.
+      { # Describes the CIS benchmark version that is applicable to a given OS and os version.
+        &quot;cpeUri&quot;: &quot;A String&quot;, # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+        &quot;version&quot;: &quot;A String&quot;, # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+      },
+    ],
+  },
   &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
   &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
     &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
@@ -932,6 +1017,23 @@ <h3>Method Details</h3>
       &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
     },
   },
+  &quot;compliance&quot;: { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check.
+    &quot;cisBenchmark&quot;: { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future.
+      &quot;profileLevel&quot;: 42, # The profile level of this CIS benchmark check.
+      &quot;severity&quot;: &quot;A String&quot;, # The severity level of this CIS benchmark check.
+    },
+    &quot;description&quot;: &quot;A String&quot;, # A description about this compliance check.
+    &quot;rationale&quot;: &quot;A String&quot;, # A rationale for the existence of this compliance check.
+    &quot;remediation&quot;: &quot;A String&quot;, # A description of remediation steps if the compliance check fails.
+    &quot;scanInstructions&quot;: &quot;A String&quot;, # Serialized scan instructions with a predefined format.
+    &quot;title&quot;: &quot;A String&quot;, # The title that identifies this compliance check.
+    &quot;version&quot;: [ # The OS and config versions the benchmark applies to.
+      { # Describes the CIS benchmark version that is applicable to a given OS and os version.
+        &quot;cpeUri&quot;: &quot;A String&quot;, # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
+        &quot;version&quot;: &quot;A String&quot;, # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
+      },
+    ],
+  },
   &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
   &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
     &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.

diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html
@@ -255,6 +255,16 @@ <h3>Method Details</h3>
         },
         &quot;provenanceBytes&quot;: &quot;A String&quot;, # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.
       },
+      &quot;compliance&quot;: { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes whether or not a resource passes compliance checks.
+        &quot;nonComplianceReason&quot;: &quot;A String&quot;, # The reason for non compliance of these files.
+        &quot;nonCompliantFiles&quot;: [ # A list of files which are violating compliance checks.
+          { # Details about files that caused a compliance check to fail.
+            &quot;displayCommand&quot;: &quot;A String&quot;, # Command to display the non-compliant files.
+            &quot;path&quot;: &quot;A String&quot;, # display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using &#x27;path&#x27;. Empty if `display_command` is set.
+            &quot;reason&quot;: &quot;A String&quot;, # Explains why a file is non compliant for a CIS check.
+          },
+        ],
+      },
       &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this `Occurrence` was created.
       &quot;deployment&quot;: { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
         &quot;address&quot;: &quot;A String&quot;, # Address of the runtime element hosting this deployment.