ConsoleNotification [console.openshift.io/v1] - Console APIs | API reference

Specification
- .spec
- .spec.link
API endpoints

Description

ConsoleNotification is the extension for configuring openshift web console notifications. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

Type

object

Required

spec

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	ConsoleNotificationSpec is the desired console notification configuration.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ConsoleNotificationSpec is the desired console notification configuration.

.spec

Description

ConsoleNotificationSpec is the desired console notification configuration.

Type

object

Required

text

Property Type Description

Property	Type	Description
`backgroundColor`	`string`	backgroundColor is the color of the background for the notification as CSS data type color.
`color`	`string`	color is the color of the text for the notification as CSS data type color.
`link`	`object`	link is an object that holds notification link details.
`location`	`string`	location is the location of the notification in the console. Valid values are: "BannerTop", "BannerBottom", "BannerTopBottom".
`text`	`string`	text is the visible text of the notification.

backgroundColor

string

backgroundColor is the color of the background for the notification as CSS data type color.

color

string

color is the color of the text for the notification as CSS data type color.

link

object

link is an object that holds notification link details.

location

string

location is the location of the notification in the console. Valid values are: "BannerTop", "BannerBottom", "BannerTopBottom".

text

string

text is the visible text of the notification.

.spec.link

Description

link is an object that holds notification link details.

Type

object

Required

href
text

Property Type Description

Property	Type	Description
`href`	`string`	href is the absolute secure URL for the link (must use https)
`text`	`string`	text is the display text for the link

href

string

href is the absolute secure URL for the link (must use https)

text

string

text is the display text for the link

API endpoints

The following API endpoints are available:

/apis/console.openshift.io/v1/consolenotifications
- DELETE: delete collection of ConsoleNotification
- GET: list objects of kind ConsoleNotification
- POST: create a ConsoleNotification
/apis/console.openshift.io/v1/consolenotifications/{name}
- DELETE: delete a ConsoleNotification
- GET: read the specified ConsoleNotification
- PATCH: partially update the specified ConsoleNotification
- PUT: replace the specified ConsoleNotification
/apis/console.openshift.io/v1/consolenotifications/{name}/status
- GET: read status of the specified ConsoleNotification
- PATCH: partially update status of the specified ConsoleNotification
- PUT: replace status of the specified ConsoleNotification

/apis/console.openshift.io/v1/consolenotifications

HTTP method: DELETE
Description: delete collection of ConsoleNotification

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind ConsoleNotification

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`ConsoleNotificationList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ConsoleNotification

Table 3. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 4. Body parameters
Parameter	Type	Description
`body`	`ConsoleNotification` schema

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`ConsoleNotification` schema
201 - Created	`ConsoleNotification` schema
202 - Accepted	`ConsoleNotification` schema
401 - Unauthorized	Empty

/apis/console.openshift.io/v1/consolenotifications/{name}

Table 6. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ConsoleNotification

HTTP method: DELETE
Description: delete a ConsoleNotification

Table 7. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ConsoleNotification

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`ConsoleNotification` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ConsoleNotification

Table 10. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`ConsoleNotification` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ConsoleNotification

Table 12. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. Body parameters
Parameter	Type	Description
`body`	`ConsoleNotification` schema

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`ConsoleNotification` schema
201 - Created	`ConsoleNotification` schema
401 - Unauthorized	Empty

/apis/console.openshift.io/v1/consolenotifications/{name}/status

Table 15. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ConsoleNotification

HTTP method: GET
Description: read status of the specified ConsoleNotification

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`ConsoleNotification` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified ConsoleNotification

Table 17. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`ConsoleNotification` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified ConsoleNotification

Table 19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 20. Body parameters
Parameter	Type	Description
`body`	`ConsoleNotification` schema

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`ConsoleNotification` schema
201 - Created	`ConsoleNotification` schema
401 - Unauthorized	Empty