diff --git a/rest_api/AuthService/_v1_auth_m2m_config.id_put.adoc b/rest_api/AuthService/_v1_auth_m2m_config.id_put.adoc index ecfeba41e9aa..636a271092d8 100644 --- a/rest_api/AuthService/_v1_auth_m2m_config.id_put.adoc +++ b/rest_api/AuthService/_v1_auth_m2m_config.id_put.adoc @@ -115,7 +115,7 @@ endif::internal-generation[] [id="AuthMachineToMachineConfigMapping_{context}"] === _AuthMachineToMachineConfigMapping_ - + Mappings map an identity token's claim values to a specific role within Central. @@ -126,25 +126,25 @@ Mappings map an identity token's claim values to a specific role within Central. | Field Name| Required| Nullable | Type| Description | Format | key -| -| -| String +| +| +| String | A key within the identity token's claim value to use. -| +| | valueExpression -| -| -| String +| +| +| String | A regular expression that will be evaluated against values of the identity token claim identified by the specified key. This regular expressions is in RE2 format, see more here: https://github.com/google/re2/wiki/Syntax. -| +| | role -| -| -| String +| +| +| String | The role which should be issued when the key and value match for a particular identity token. -| +| |=== @@ -152,7 +152,7 @@ Mappings map an identity token's claim values to a specific role within Central. [id="AuthServiceUpdateAuthMachineToMachineConfigBody_{context}"] === _AuthServiceUpdateAuthMachineToMachineConfigBody_ - + @@ -163,11 +163,11 @@ Mappings map an identity token's claim values to a specific role within Central. | Field Name| Required| Nullable | Type| Description | Format | config -| -| -| <> -| -| +| +| +| <> +| +| |=== @@ -175,7 +175,7 @@ Mappings map an identity token's claim values to a specific role within Central. [id="AuthServiceUpdateAuthMachineToMachineConfigBodyConfig_{context}"] === _AuthServiceUpdateAuthMachineToMachineConfigBodyConfig_ - + AuthMachineToMachineConfig determines rules for exchanging an identity token from a third party with a Central access token. The M2M stands for machine to machine, as this is the intended use-case @@ -188,32 +188,32 @@ for the config. | Field Name| Required| Nullable | Type| Description | Format | type -| -| -| <> -| -| GENERIC, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT, +| +| +| <> +| +| GENERIC, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT, | tokenExpirationDuration -| -| -| String +| +| +| String | Sets the expiration of the token returned from the ExchangeAuthMachineToMachineToken API call. Possible valid time units are: s, m, h. The maximum allowed expiration duration is 24h. As an example: 2h45m. For additional information on the validation of the duration, see: https://pkg.go.dev/time#ParseDuration. -| +| | mappings -| -| +| +| | List of <> | At least one mapping is required to resolve to a valid role for the access token to be successfully generated. -| +| | issuer -| -| -| String +| +| +| String | The issuer of the related OIDC provider issuing the ID tokens to exchange. Must be non-empty string containing URL when type is GENERIC. In case of GitHub actions, this must be empty or set to https://token.actions.githubusercontent.com. Issuer is a unique key, therefore there may be at most one GITHUB_ACTIONS config, and each GENERIC config must have a distinct issuer. -| +| |=== @@ -221,7 +221,7 @@ for the config. [id="GooglerpcStatus_{context}"] === _GooglerpcStatus_ - + @@ -232,25 +232,25 @@ for the config. | Field Name| Required| Nullable | Type| Description | Format | code -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | message -| -| -| String -| -| +| +| +| String +| +| | details -| -| +| +| | List of <> -| -| +| +| |=== @@ -258,7 +258,7 @@ for the config. [id="ProtobufAny_{context}"] === _ProtobufAny_ - + `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. @@ -352,11 +352,11 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | @type -| -| -| String +| +| +| String | A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. -| +| |=== @@ -364,7 +364,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="V1AuthMachineToMachineConfigType_{context}"] === _V1AuthMachineToMachineConfigType_ - + The type of the auth machine to machine config. Currently supports GitHub actions or any other generic OIDC provider to use for verifying and diff --git a/rest_api/CloudSourcesService/_v1_cloud-sources_cloudSource.id_put.adoc b/rest_api/CloudSourcesService/_v1_cloud-sources_cloudSource.id_put.adoc index 324e88aeeb98..b3837b832855 100644 --- a/rest_api/CloudSourcesService/_v1_cloud-sources_cloudSource.id_put.adoc +++ b/rest_api/CloudSourcesService/_v1_cloud-sources_cloudSource.id_put.adoc @@ -115,7 +115,7 @@ endif::internal-generation[] [id="CloudSourcesServiceUpdateCloudSourceBody_{context}"] === _CloudSourcesServiceUpdateCloudSourceBody_ - + @@ -126,18 +126,18 @@ endif::internal-generation[] | Field Name| Required| Nullable | Type| Description | Format | cloudSource -| -| -| <> -| -| +| +| +| <> +| +| | updateCredentials -| -| -| Boolean +| +| +| Boolean | If true, cloud_source must include valid credentials. If false, the resource must already exist and credentials in cloud_source are ignored. -| +| |=== @@ -145,7 +145,7 @@ endif::internal-generation[] [id="CloudSourcesServiceUpdateCloudSourceBodyCloudSource_{context}"] === _CloudSourcesServiceUpdateCloudSourceBodyCloudSource_ - + CloudSource is an integration which provides a source for discovered clusters. @@ -157,46 +157,46 @@ clusters. | Field Name| Required| Nullable | Type| Description | Format | name -| -| -| String -| -| +| +| +| String +| +| | type -| -| -| <> -| -| TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM, +| +| +| <> +| +| TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM, | credentials -| -| -| <> -| -| +| +| +| <> +| +| | skipTestIntegration -| -| -| Boolean -| -| +| +| +| Boolean +| +| | paladinCloud -| -| -| <> -| -| +| +| +| <> +| +| | ocm -| -| -| <> -| -| +| +| +| <> +| +| |=== @@ -204,7 +204,7 @@ clusters. [id="GooglerpcStatus_{context}"] === _GooglerpcStatus_ - + @@ -215,25 +215,25 @@ clusters. | Field Name| Required| Nullable | Type| Description | Format | code -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | message -| -| -| String -| -| +| +| +| String +| +| | details -| -| +| +| | List of <> -| -| +| +| |=== @@ -241,7 +241,7 @@ clusters. [id="ProtobufAny_{context}"] === _ProtobufAny_ - + `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. @@ -335,11 +335,11 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | @type -| -| -| String +| +| +| String | A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. -| +| |=== @@ -347,7 +347,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="V1CloudSourceCredentials_{context}"] === _V1CloudSourceCredentials_ - + @@ -358,25 +358,25 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | secret -| -| -| String +| +| +| String | Used for single-valued authentication via long-lived tokens. -| +| | clientId -| -| -| String +| +| +| String | Used for client authentication in combination with client_secret. -| +| | clientSecret -| -| -| String +| +| +| String | Used for client authentication in combination with client_id. -| +| |=== @@ -384,7 +384,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="V1CloudSourceType_{context}"] === _V1CloudSourceType_ - + @@ -405,7 +405,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="V1OCMConfig_{context}"] === _V1OCMConfig_ - + OCMConfig provides information required to fetch discovered clusters from the OpenShift cluster manager. @@ -417,11 +417,11 @@ the OpenShift cluster manager. | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| |=== @@ -429,7 +429,7 @@ the OpenShift cluster manager. [id="V1PaladinCloudConfig_{context}"] === _V1PaladinCloudConfig_ - + PaladinCloudConfig provides information required to fetch discovered clusters from Paladin Cloud. @@ -441,11 +441,11 @@ clusters from Paladin Cloud. | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| |=== diff --git a/rest_api/ExternalBackupService/_v1_externalbackups_externalBackup.id_patch.adoc b/rest_api/ExternalBackupService/_v1_externalbackups_externalBackup.id_patch.adoc index 490e1cabc906..2613bb6a0c83 100644 --- a/rest_api/ExternalBackupService/_v1_externalbackups_externalBackup.id_patch.adoc +++ b/rest_api/ExternalBackupService/_v1_externalbackups_externalBackup.id_patch.adoc @@ -114,7 +114,7 @@ endif::internal-generation[] [id="ExternalBackupServiceUpdateExternalBackupBody_{context}"] === _ExternalBackupServiceUpdateExternalBackupBody_ - + @@ -125,18 +125,18 @@ endif::internal-generation[] | Field Name| Required| Nullable | Type| Description | Format | externalBackup -| -| -| <> -| -| +| +| +| <> +| +| | updatePassword -| -| -| Boolean +| +| +| Boolean | When false, use the stored credentials of an existing external backup configuration given its ID. -| +| |=== @@ -144,7 +144,7 @@ endif::internal-generation[] [id="GooglerpcStatus_{context}"] === _GooglerpcStatus_ - + @@ -155,25 +155,25 @@ endif::internal-generation[] | Field Name| Required| Nullable | Type| Description | Format | code -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | message -| -| -| String -| -| +| +| +| String +| +| | details -| -| +| +| | List of <> -| -| +| +| |=== @@ -192,60 +192,60 @@ endif::internal-generation[] | Field Name| Required| Nullable | Type| Description | Format | name -| -| -| String -| -| +| +| +| String +| +| | type -| -| -| String -| -| +| +| +| String +| +| | schedule -| -| -| <> -| -| +| +| +| <> +| +| | backupsToKeep -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | s3 -| -| -| <> -| -| +| +| +| <> +| +| | gcs -| -| -| <> -| -| +| +| +| <> +| +| | s3compatible -| -| -| <> -| -| +| +| +| <> +| +| | includeCertificates -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -253,7 +253,7 @@ endif::internal-generation[] [id="ProtobufAny_{context}"] === _ProtobufAny_ - + `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. @@ -347,11 +347,11 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | @type -| -| -| String +| +| +| String | A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. -| +| |=== @@ -370,11 +370,11 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | days -| -| +| +| | List of `integer` -| -| int32 +| +| int32 |=== @@ -393,11 +393,11 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | days -| -| +| +| | List of `integer` -| -| int32 +| +| int32 |=== @@ -405,7 +405,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="ScheduleIntervalType_{context}"] === _ScheduleIntervalType_ - + @@ -427,7 +427,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="ScheduleWeeklyInterval_{context}"] === _ScheduleWeeklyInterval_ - + @@ -438,11 +438,11 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | day -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 |=== @@ -461,67 +461,67 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | id -| -| -| String -| -| +| +| +| String +| +| | name -| -| -| String -| -| +| +| +| String +| +| | type -| -| -| String -| -| +| +| +| String +| +| | schedule -| -| -| <> -| -| +| +| +| <> +| +| | backupsToKeep -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | s3 -| -| -| <> -| -| +| +| +| <> +| +| | gcs -| -| -| <> -| -| +| +| +| <> +| +| | s3compatible -| -| -| <> -| -| +| +| +| <> +| +| | includeCertificates -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -529,7 +529,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageGCSConfig_{context}"] === _StorageGCSConfig_ - + @@ -540,32 +540,32 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | bucket -| -| -| String -| -| +| +| +| String +| +| | serviceAccount -| -| -| String +| +| +| String | The service account for the storage integration. The server will mask the value of this credential in responses and logs. -| +| | objectPrefix -| -| -| String -| -| +| +| +| String +| +| | useWorkloadId -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -573,7 +573,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageS3Compatible_{context}"] === _StorageS3Compatible_ - + S3Compatible configures the backup integration with an S3 compatible storage provider. S3 compatible is intended for non-AWS providers. For AWS S3 use S3Config. @@ -585,53 +585,53 @@ S3 compatible is intended for non-AWS providers. For AWS S3 use S3Config. | Field Name| Required| Nullable | Type| Description | Format | bucket -| -| -| String -| -| +| +| +| String +| +| | accessKeyId -| -| -| String +| +| +| String | The access key ID to use. The server will mask the value of this credential in responses and logs. -| +| | secretAccessKey -| -| -| String +| +| +| String | The secret access key to use. The server will mask the value of this credential in responses and logs. -| +| | region -| -| -| String -| -| +| +| +| String +| +| | objectPrefix -| -| -| String -| -| +| +| +| String +| +| | endpoint -| -| -| String -| -| +| +| +| String +| +| | urlStyle -| -| -| <> -| -| S3_URL_STYLE_UNSPECIFIED, S3_URL_STYLE_VIRTUAL_HOSTED, S3_URL_STYLE_PATH, +| +| +| <> +| +| S3_URL_STYLE_UNSPECIFIED, S3_URL_STYLE_VIRTUAL_HOSTED, S3_URL_STYLE_PATH, |=== @@ -639,7 +639,7 @@ S3 compatible is intended for non-AWS providers. For AWS S3 use S3Config. [id="StorageS3Config_{context}"] === _StorageS3Config_ - + S3Config configures the backup integration with AWS S3. @@ -650,53 +650,53 @@ S3Config configures the backup integration with AWS S3. | Field Name| Required| Nullable | Type| Description | Format | bucket -| -| -| String -| -| +| +| +| String +| +| | useIam -| -| -| Boolean -| -| +| +| +| Boolean +| +| | accessKeyId -| -| -| String +| +| +| String | The access key ID for the storage integration. The server will mask the value of this credential in responses and logs. -| +| | secretAccessKey -| -| -| String +| +| +| String | The secret access key for the storage integration. The server will mask the value of this credential in responses and logs. -| +| | region -| -| -| String -| -| +| +| +| String +| +| | objectPrefix -| -| -| String -| -| +| +| +| String +| +| | endpoint -| -| -| String -| -| +| +| +| String +| +| |=== @@ -704,7 +704,7 @@ S3Config configures the backup integration with AWS S3. [id="StorageS3URLStyle_{context}"] === _StorageS3URLStyle_ - + @@ -725,7 +725,7 @@ S3Config configures the backup integration with AWS S3. [id="StorageSchedule_{context}"] === _StorageSchedule_ - + @@ -736,46 +736,46 @@ S3Config configures the backup integration with AWS S3. | Field Name| Required| Nullable | Type| Description | Format | intervalType -| -| -| <> -| -| UNSET, DAILY, WEEKLY, MONTHLY, +| +| +| <> +| +| UNSET, DAILY, WEEKLY, MONTHLY, | hour -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | minute -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | weekly -| -| -| <> -| -| +| +| +| <> +| +| | daysOfWeek -| -| -| <> -| -| +| +| +| <> +| +| | daysOfMonth -| -| -| <> -| -| +| +| +| <> +| +| |=== diff --git a/rest_api/ImageIntegrationService/_v1_imageintegrations_config.id_patch.adoc b/rest_api/ImageIntegrationService/_v1_imageintegrations_config.id_patch.adoc index 408a611a88f7..a106acbc564f 100644 --- a/rest_api/ImageIntegrationService/_v1_imageintegrations_config.id_patch.adoc +++ b/rest_api/ImageIntegrationService/_v1_imageintegrations_config.id_patch.adoc @@ -115,7 +115,7 @@ endif::internal-generation[] [id="ECRConfigAuthorizationData_{context}"] === _ECRConfigAuthorizationData_ - + An authorization data represents the IAM authentication credentials and can be used to access any Amazon ECR registry that the IAM principal has @@ -128,25 +128,25 @@ access to. | Field Name| Required| Nullable | Type| Description | Format | username -| -| -| String -| -| +| +| +| String +| +| | password -| -| -| String -| -| +| +| +| String +| +| | expiresAt -| -| -| Date -| -| date-time +| +| +| Date +| +| date-time |=== @@ -154,7 +154,7 @@ access to. [id="GooglerpcStatus_{context}"] === _GooglerpcStatus_ - + @@ -165,25 +165,25 @@ access to. | Field Name| Required| Nullable | Type| Description | Format | code -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | message -| -| -| String -| -| +| +| +| String +| +| | details -| -| +| +| | List of <> -| -| +| +| |=== @@ -191,7 +191,7 @@ access to. [id="ImageIntegrationServiceUpdateImageIntegrationBody_{context}"] === _ImageIntegrationServiceUpdateImageIntegrationBody_ - + @@ -202,18 +202,18 @@ access to. | Field Name| Required| Nullable | Type| Description | Format | config -| -| -| <> -| -| +| +| +| <> +| +| | updatePassword -| -| -| Boolean +| +| +| Boolean | When false, use the stored credentials of an existing image integration given its ID. -| +| |=== @@ -232,123 +232,123 @@ access to. | Field Name| Required| Nullable | Type| Description | Format | name -| -| -| String -| -| +| +| +| String +| +| | type -| -| -| String -| -| +| +| +| String +| +| | categories -| -| +| +| | List of <> -| -| +| +| | clairify -| -| -| <> -| -| +| +| +| <> +| +| | scannerV4 -| -| -| <> -| -| +| +| +| <> +| +| | docker -| -| -| <> -| -| +| +| +| <> +| +| | quay -| -| -| <> -| -| +| +| +| <> +| +| | ecr -| -| -| <> -| -| +| +| +| <> +| +| | google -| -| -| <> -| -| +| +| +| <> +| +| | clair -| -| -| <> -| -| +| +| +| <> +| +| | clairV4 -| -| -| <> -| -| +| +| +| <> +| +| | ibm -| -| -| <> -| -| +| +| +| <> +| +| | azure -| -| -| <> -| -| +| +| +| <> +| +| | autogenerated -| -| -| Boolean -| -| +| +| +| Boolean +| +| | clusterId -| -| -| String -| -| +| +| +| String +| +| | skipTestIntegration -| -| -| Boolean -| -| +| +| +| Boolean +| +| | source -| -| -| <> -| -| +| +| +| <> +| +| |=== @@ -356,7 +356,7 @@ access to. [id="ProtobufAny_{context}"] === _ProtobufAny_ - + `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. @@ -450,11 +450,11 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | @type -| -| -| String +| +| +| String | A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. -| +| |=== @@ -473,18 +473,18 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | username -| -| -| String -| -| +| +| +| String +| +| | password -| -| -| String +| +| +| String | The server will mask the value of this password in responses and logs. -| +| |=== @@ -492,7 +492,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageAzureConfig_{context}"] === _StorageAzureConfig_ - + @@ -503,32 +503,32 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| | username -| -| -| String -| -| +| +| +| String +| +| | password -| -| -| String +| +| +| String | The password for the integration. The server will mask the value of this credential in responses and logs. -| +| | wifEnabled -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -536,7 +536,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageClairConfig_{context}"] === _StorageClairConfig_ - + @@ -547,18 +547,18 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| | insecure -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -566,7 +566,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageClairV4Config_{context}"] === _StorageClairV4Config_ - + @@ -577,18 +577,18 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| | insecure -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -596,7 +596,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageClairifyConfig_{context}"] === _StorageClairifyConfig_ - + @@ -607,25 +607,25 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| | grpcEndpoint -| -| -| String -| -| +| +| +| String +| +| | numConcurrentScans -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 |=== @@ -633,7 +633,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageDockerConfig_{context}"] === _StorageDockerConfig_ - + @@ -644,32 +644,32 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| | username -| -| -| String -| -| +| +| +| String +| +| | password -| -| -| String +| +| +| String | The password for the integration. The server will mask the value of this credential in responses and logs. -| +| | insecure -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -677,7 +677,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageECRConfig_{context}"] === _StorageECRConfig_ - + @@ -688,74 +688,74 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | registryId -| -| -| String -| -| +| +| +| String +| +| | accessKeyId -| -| -| String +| +| +| String | The access key ID for the integration. The server will mask the value of this credential in responses and logs. -| +| | secretAccessKey -| -| -| String +| +| +| String | The secret access key for the integration. The server will mask the value of this credential in responses and logs. -| +| | region -| -| -| String -| -| +| +| +| String +| +| | useIam -| -| -| Boolean -| -| +| +| +| Boolean +| +| | endpoint -| -| -| String -| -| +| +| +| String +| +| | useAssumeRole -| -| -| Boolean -| -| +| +| +| Boolean +| +| | assumeRoleId -| -| -| String -| -| +| +| +| String +| +| | assumeRoleExternalId -| -| -| String -| -| +| +| +| String +| +| | authorizationData -| -| -| <> -| -| +| +| +| <> +| +| |=== @@ -763,7 +763,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageGoogleConfig_{context}"] === _StorageGoogleConfig_ - + @@ -774,32 +774,32 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| | serviceAccount -| -| -| String +| +| +| String | The service account for the integration. The server will mask the value of this credential in responses and logs. -| +| | project -| -| -| String -| -| +| +| +| String +| +| | wifEnabled -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -807,7 +807,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageIBMRegistryConfig_{context}"] === _StorageIBMRegistryConfig_ - + @@ -818,18 +818,18 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| | apiKey -| -| -| String +| +| +| String | The API key for the integration. The server will mask the value of this credential in responses and logs. -| +| |=== @@ -837,7 +837,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageImageIntegrationCategory_{context}"] === _StorageImageIntegrationCategory_ - + - NODE_SCANNER: Image and Node integrations are currently done on the same form in the UI so the image integration is also currently used for node integrations. @@ -860,7 +860,7 @@ This decision was made because we currently only support one node scanner (our s [id="StorageImageIntegrationSource_{context}"] === _StorageImageIntegrationSource_ - + @@ -871,25 +871,25 @@ This decision was made because we currently only support one node scanner (our s | Field Name| Required| Nullable | Type| Description | Format | clusterId -| -| -| String -| -| +| +| +| String +| +| | namespace -| -| -| String -| -| +| +| +| String +| +| | imagePullSecretName -| -| -| String -| -| +| +| +| String +| +| |=== @@ -897,7 +897,7 @@ This decision was made because we currently only support one node scanner (our s [id="StorageQuayConfig_{context}"] === _StorageQuayConfig_ - + @@ -908,32 +908,32 @@ This decision was made because we currently only support one node scanner (our s | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| | oauthToken -| -| -| String +| +| +| String | The OAuth token for the integration. Required if this is a scanner integration. The server will mask the value of this credential in responses and logs. -| +| | insecure -| -| -| Boolean -| -| +| +| +| Boolean +| +| | registryRobotCredentials -| -| -| <> -| -| +| +| +| <> +| +| |=== @@ -941,7 +941,7 @@ This decision was made because we currently only support one node scanner (our s [id="StorageScannerV4Config_{context}"] === _StorageScannerV4Config_ - + @@ -952,25 +952,25 @@ This decision was made because we currently only support one node scanner (our s | Field Name| Required| Nullable | Type| Description | Format | numConcurrentScans -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | indexerEndpoint -| -| -| String -| -| +| +| +| String +| +| | matcherEndpoint -| -| -| String -| -| +| +| +| String +| +| |=== diff --git a/rest_api/NotifierService/_v1_notifiers_notifier.id_patch.adoc b/rest_api/NotifierService/_v1_notifiers_notifier.id_patch.adoc index 0d4a3cb908b3..cbac192ab94a 100644 --- a/rest_api/NotifierService/_v1_notifiers_notifier.id_patch.adoc +++ b/rest_api/NotifierService/_v1_notifiers_notifier.id_patch.adoc @@ -115,7 +115,7 @@ endif::internal-generation[] [id="EmailAuthMethod_{context}"] === _EmailAuthMethod_ - + @@ -136,7 +136,7 @@ endif::internal-generation[] [id="GooglerpcStatus_{context}"] === _GooglerpcStatus_ - + @@ -147,25 +147,25 @@ endif::internal-generation[] | Field Name| Required| Nullable | Type| Description | Format | code -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | message -| -| -| String -| -| +| +| +| String +| +| | details -| -| +| +| | List of <> -| -| +| +| |=== @@ -173,7 +173,7 @@ endif::internal-generation[] [id="JiraPriorityMapping_{context}"] === _JiraPriorityMapping_ - + @@ -184,18 +184,18 @@ endif::internal-generation[] | Field Name| Required| Nullable | Type| Description | Format | severity -| -| -| <> -| -| UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, +| +| +| <> +| +| UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | priorityName -| -| -| String -| -| +| +| +| String +| +| |=== @@ -214,18 +214,18 @@ endif::internal-generation[] | Field Name| Required| Nullable | Type| Description | Format | clientCert -| -| -| String +| +| +| String | PEM encoded ASN.1 DER format. -| +| | privateKey -| -| -| String +| +| +| String | PEM encoded PKCS #8, ASN.1 DER format. -| +| |=== @@ -233,7 +233,7 @@ endif::internal-generation[] [id="MicrosoftSentinelDataCollectionRuleConfig_{context}"] === _MicrosoftSentinelDataCollectionRuleConfig_ - + DataCollectionRuleConfig contains information about the data collection rule which is a config per notifier type. @@ -244,25 +244,25 @@ DataCollectionRuleConfig contains information about the data collection rule whi | Field Name| Required| Nullable | Type| Description | Format | streamName -| -| -| String -| -| +| +| +| String +| +| | dataCollectionRuleId -| -| -| String -| -| +| +| +| String +| +| | enabled -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -281,123 +281,123 @@ DataCollectionRuleConfig contains information about the data collection rule whi | Field Name| Required| Nullable | Type| Description | Format | name -| -| -| String -| -| +| +| +| String +| +| | type -| -| -| String -| -| +| +| +| String +| +| | uiEndpoint -| -| -| String -| -| +| +| +| String +| +| | labelKey -| -| -| String -| -| +| +| +| String +| +| | labelDefault -| -| -| String -| -| +| +| +| String +| +| | jira -| -| -| <> -| -| +| +| +| <> +| +| | email -| -| -| <> -| -| +| +| +| <> +| +| | cscc -| -| -| <> -| -| +| +| +| <> +| +| | splunk -| -| -| <> -| -| +| +| +| <> +| +| | pagerduty -| -| -| <> -| -| +| +| +| <> +| +| | generic -| -| -| <> -| -| +| +| +| <> +| +| | sumologic -| -| -| <> -| -| +| +| +| <> +| +| | awsSecurityHub -| -| -| <> -| -| +| +| +| <> +| +| | syslog -| -| -| <> -| -| +| +| +| <> +| +| | microsoftSentinel -| -| -| <> -| -| +| +| +| <> +| +| | notifierSecret -| -| -| String -| -| +| +| +| String +| +| | traits -| -| -| <> -| -| +| +| +| <> +| +| |=== @@ -405,7 +405,7 @@ DataCollectionRuleConfig contains information about the data collection rule whi [id="NotifierServiceUpdateNotifierBody_{context}"] === _NotifierServiceUpdateNotifierBody_ - + @@ -416,18 +416,18 @@ DataCollectionRuleConfig contains information about the data collection rule whi | Field Name| Required| Nullable | Type| Description | Format | notifier -| -| -| <> -| -| +| +| +| <> +| +| | updatePassword -| -| -| Boolean +| +| +| Boolean | When false, use the stored credentials of an existing notifier configuration given its ID. -| +| |=== @@ -435,7 +435,7 @@ DataCollectionRuleConfig contains information about the data collection rule whi [id="ProtobufAny_{context}"] === _ProtobufAny_ - + `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. @@ -529,11 +529,11 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | @type -| -| -| String +| +| +| String | A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. -| +| |=== @@ -541,7 +541,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageAWSSecurityHub_{context}"] === _StorageAWSSecurityHub_ - + @@ -552,25 +552,25 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | region -| -| -| String -| -| +| +| +| String +| +| | credentials -| -| -| <> -| -| +| +| +| <> +| +| | accountId -| -| -| String -| -| +| +| +| String +| +| |=== @@ -578,7 +578,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageAWSSecurityHubCredentials_{context}"] === _StorageAWSSecurityHubCredentials_ - + @@ -589,25 +589,25 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | accessKeyId -| -| -| String -| -| +| +| +| String +| +| | secretAccessKey -| -| -| String -| -| +| +| +| String +| +| | stsEnabled -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -615,7 +615,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageCSCC_{context}"] === _StorageCSCC_ - + @@ -626,25 +626,25 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | serviceAccount -| -| -| String +| +| +| String | The service account for the integration. The server will mask the value of this credential in responses and logs. -| +| | sourceId -| -| -| String -| -| +| +| +| String +| +| | wifEnabled -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -652,7 +652,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageEmail_{context}"] === _StorageEmail_ - + @@ -663,67 +663,67 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | server -| -| -| String -| -| +| +| +| String +| +| | sender -| -| -| String -| -| +| +| +| String +| +| | username -| -| -| String -| -| +| +| +| String +| +| | password -| -| -| String +| +| +| String | The password for the integration. The server will mask the value of this credential in responses and logs. -| +| | disableTLS -| -| -| Boolean -| -| +| +| +| Boolean +| +| | DEPRECATEDUseStartTLS -| -| -| Boolean -| -| +| +| +| Boolean +| +| | from -| -| -| String -| -| +| +| +| String +| +| | startTLSAuthMethod -| -| -| <> -| -| DISABLED, PLAIN, LOGIN, +| +| +| <> +| +| DISABLED, PLAIN, LOGIN, | allowUnauthenticatedSmtp -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -731,7 +731,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageGeneric_{context}"] === _StorageGeneric_ - + @@ -742,60 +742,60 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | endpoint -| -| -| String -| -| +| +| +| String +| +| | skipTLSVerify -| -| -| Boolean -| -| +| +| +| Boolean +| +| | caCert -| -| -| String -| -| +| +| +| String +| +| | username -| -| -| String -| -| +| +| +| String +| +| | password -| -| -| String +| +| +| String | The password for the integration. The server will mask the value of this credential in responses and logs. -| +| | headers -| -| +| +| | List of <> -| -| +| +| | extraFields -| -| +| +| | List of <> -| -| +| +| | auditLoggingEnabled -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -803,7 +803,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageJira_{context}"] === _StorageJira_ - + @@ -814,53 +814,53 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | url -| -| -| String -| -| +| +| +| String +| +| | username -| -| -| String -| -| +| +| +| String +| +| | password -| -| -| String +| +| +| String | The password for the integration. The server will mask the value of this credential in responses and logs. -| +| | issueType -| -| -| String -| -| +| +| +| String +| +| | priorityMappings -| -| +| +| | List of <> -| -| +| +| | defaultFieldsJson -| -| -| String -| -| +| +| +| String +| +| | disablePriority -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -868,7 +868,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageKeyValuePair_{context}"] === _StorageKeyValuePair_ - + @@ -879,18 +879,18 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | key -| -| -| String -| -| +| +| +| String +| +| | value -| -| -| String -| -| +| +| +| String +| +| |=== @@ -898,7 +898,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageMicrosoftSentinel_{context}"] === _StorageMicrosoftSentinel_ - + @@ -909,53 +909,53 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | logIngestionEndpoint -| -| -| String +| +| +| String | log_ingestion_endpoint is the log ingestion endpoint. -| +| | directoryTenantId -| -| -| String +| +| +| String | directory_tenant_id contains the ID of the Microsoft Directory ID of the selected tenant. -| +| | applicationClientId -| -| -| String +| +| +| String | application_client_id contains the ID of the application ID of the service principal. -| +| | secret -| -| -| String +| +| +| String | secret contains the client secret. -| +| | alertDcrConfig -| -| -| <> -| -| +| +| +| <> +| +| | auditLogDcrConfig -| -| -| <> -| -| +| +| +| <> +| +| | clientCertAuthConfig -| -| -| <> -| -| +| +| +| <> +| +| |=== @@ -963,7 +963,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StoragePagerDuty_{context}"] === _StoragePagerDuty_ - + @@ -974,11 +974,11 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | apiKey -| -| -| String +| +| +| String | The API key for the integration. The server will mask the value of this credential in responses and logs. -| +| |=== @@ -986,7 +986,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageSeverity_{context}"] === _StorageSeverity_ - + @@ -1009,7 +1009,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageSplunk_{context}"] === _StorageSplunk_ - + @@ -1020,53 +1020,53 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | httpToken -| -| -| String +| +| +| String | The HTTP token for the integration. The server will mask the value of this credential in responses and logs. -| +| | httpEndpoint -| -| -| String -| -| +| +| +| String +| +| | insecure -| -| -| Boolean -| -| +| +| +| Boolean +| +| | truncate -| -| -| String -| -| int64 +| +| +| String +| +| int64 | auditLoggingEnabled -| -| -| Boolean -| -| +| +| +| Boolean +| +| | derivedSourceType -| -| -| Boolean -| -| +| +| +| Boolean +| +| | sourceTypes -| -| +| +| | Map of `string` -| -| +| +| |=== @@ -1074,7 +1074,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageSumoLogic_{context}"] === _StorageSumoLogic_ - + @@ -1085,18 +1085,18 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | httpSourceAddress -| -| -| String -| -| +| +| +| String +| +| | skipTLSVerify -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -1104,7 +1104,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageSyslog_{context}"] === _StorageSyslog_ - + @@ -1115,32 +1115,32 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | localFacility -| -| -| <> -| -| LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7, +| +| +| <> +| +| LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7, | tcpConfig -| -| -| <> -| -| +| +| +| <> +| +| | extraFields -| -| +| +| | List of <> -| -| +| +| | messageFormat -| -| -| <> -| -| LEGACY, CEF, +| +| +| <> +| +| LEGACY, CEF, |=== @@ -1148,7 +1148,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="StorageTraits_{context}"] === _StorageTraits_ - + @@ -1159,25 +1159,25 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | mutabilityMode -| -| -| <> -| -| ALLOW_MUTATE, ALLOW_MUTATE_FORCED, +| +| +| <> +| +| ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | visibility -| -| -| <> -| -| VISIBLE, HIDDEN, +| +| +| <> +| +| VISIBLE, HIDDEN, | origin -| -| -| <> -| -| IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, +| +| +| <> +| +| IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |=== @@ -1185,7 +1185,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="SyslogLocalFacility_{context}"] === _SyslogLocalFacility_ - + @@ -1211,7 +1211,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="SyslogMessageFormat_{context}"] === _SyslogMessageFormat_ - + @@ -1231,7 +1231,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="SyslogTCPConfig_{context}"] === _SyslogTCPConfig_ - + @@ -1242,32 +1242,32 @@ field. Example (for message [google.protobuf.Duration][]): | Field Name| Required| Nullable | Type| Description | Format | hostname -| -| -| String -| -| +| +| +| String +| +| | port -| -| -| Integer -| -| int32 +| +| +| Integer +| +| int32 | skipTlsVerify -| -| -| Boolean -| -| +| +| +| Boolean +| +| | useTls -| -| -| Boolean -| -| +| +| +| Boolean +| +| |=== @@ -1275,7 +1275,7 @@ field. Example (for message [google.protobuf.Duration][]): [id="TraitsMutabilityMode_{context}"] === _TraitsMutabilityMode_ - + EXPERIMENTAL. NOTE: Please refer from using MutabilityMode for the time being. It will be replaced in the future (ROX-14276). @@ -1304,7 +1304,7 @@ changes to it, including modifying it back to ALLOW_MUTATE. [id="TraitsOrigin_{context}"] === _TraitsOrigin_ - + Origin specifies the origin of an object. Objects can have four different origins: @@ -1342,7 +1342,7 @@ They may be referenced by all other objects. [id="TraitsVisibility_{context}"] === _TraitsVisibility_ - + EXPERIMENTAL. visibility allows to specify whether the object should be visible for certain APIs. diff --git a/scripts/process-apidocs-for-pantheon.sh b/scripts/process-apidocs-for-pantheon.sh new file mode 100755 index 000000000000..5c8e2e40e03f --- /dev/null +++ b/scripts/process-apidocs-for-pantheon.sh @@ -0,0 +1,118 @@ +#!/bin/bash + +# Define color codes +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[0;33m' +BLUE='\033[0;34m' +CYAN='\033[0;36m' +NC='\033[0m' # No Color + +echo -e "${YELLOW}==========================================================================${NC}" + +echo -e "${CYAN}Only run this script after you've generated the drupal-build directory.${NC}" + +echo -e "${YELLOW}==========================================================================${NC}" + +echo -e "${BLUE}Press Enter to continue or Ctrl+C to exit.${NC}" +read -r + +BASE_DIR="./drupal-build/openshift-acs/rest_api" + +if [[ ! -d "$BASE_DIR" ]]; then + echo -e "${RED}Error: Directory '$BASE_DIR' does not exist.${NC}" + exit 1 +fi + +echo -e "${BLUE}Enter the product version number, for example: 4.6 ${NC}" +read -r PRODUCT_VERSION + +if [[ -z "$PRODUCT_VERSION" ]]; then + echo -e "${RED}Error: Product version cannot be empty.${NC}" + exit 1 +fi + +total_folders=0 +folders_with_files=0 +folders_without_files=0 +total_generated_files=0 + +camel_to_space() { + echo "$1" | sed -r 's/([a-z])([A-Z])/\1 \2/g; s/([A-Z]+)([A-Z][a-z])/\1 \2/g' +} + +for dir in "$BASE_DIR"/*/; do + if [[ ! -d "$dir" ]]; then + echo -e "${YELLOW}Warning: '$dir' is not a directory.${NC}" + continue + fi + + folder_name=$(basename "$dir") + if [[ "$folder_name" == "images" ]]; then + echo -e "${YELLOW}Skipping 'images' directory.${NC}" + continue + fi + + total_folders=$((total_folders + 1)) + folder_name=$(basename "$dir") + master_file="$dir/master.adoc" + docinfo_file="$dir/docinfo.xml" + + if [[ -f "$master_file" && -f "$docinfo_file" ]]; then + folders_with_files=$((folders_with_files + 1)) + continue + fi + + folders_without_files=$((folders_without_files + 1)) + + # Create master.adoc + echo -e "${GREEN}Creating master.adoc in $dir${NC}" + title=$(camel_to_space "$folder_name") + includes="" + + for adoc_file in "$dir"/*.adoc; do + if [[ ! -f "$adoc_file" ]]; then + echo -e "${YELLOW}Warning: No .adoc files found in '$dir'.${NC}" + continue + fi + + if [[ "$adoc_file" != "$master_file" && "$adoc_file" != "$docinfo_file" ]]; then + includes+="include::$(basename "$adoc_file")[leveloffset=+1]\n\n" + fi + done + + { + echo "= $title" + echo ":product-author: Red Hat OpenShift Documentation Team" + echo ":product-title: Red Hat Advanced Cluster Security for Kubernetes" + echo ":product-version: $PRODUCT_VERSION" + echo ":openshift-acs:" + echo ":imagesdir: images" + echo ":idseparator: -" + echo "" + echo -e "$includes" + } > "$master_file" + total_generated_files=$((total_generated_files + 1)) + + # Create docinfo.xml + echo -e "${GREEN}Creating docinfo.xml in $dir${NC}" + { + echo "$title" + echo "Red Hat Advanced Cluster Security for Kubernetes" + echo "$PRODUCT_VERSION" + echo "Reference guide for $title." + echo "" + echo " This document describes the Red Hat Advanced Cluster Security for Kubernetes API objects and their detailed specifications." + echo "" + echo "" + echo " Red Hat OpenShift Documentation Team" + echo "" + echo "" + } > "$docinfo_file" + total_generated_files=$((total_generated_files + 1)) +done + +echo -e "${BLUE}Total folders checked: $total_folders${NC}" +echo -e "${BLUE}Folders with master.adoc and docinfo.xml: $folders_with_files${NC}" +echo -e "${BLUE}Folders without files (created files): $folders_without_files${NC}" +echo -e "${BLUE}Total generated files: $total_generated_files${NC}"