openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity
Files
e59b22b53442f1ecc9d9ac3a784360a7023cf4d8
openshift-docs/rest_api/console_apis/consolelink-console-openshift-io-v1.adoc
JoeAldinger e59b22b534 OSDOCS-15079: update rest_api docs for 4.21
2026-01-27 22:07:18 +00:00

578 lines
18 KiB
Plaintext
Raw Blame History

// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="consolelink-console-openshift-io-v1"]
= ConsoleLink [console.openshift.io/v1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
ConsoleLink is an extension for customizing OpenShift web console links.
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
[cols="1,1,1",options="header"]
|===
| 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`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| ConsoleLinkSpec is the desired console link configuration.
|===
=== .spec
Description::
+
--
ConsoleLinkSpec is the desired console link configuration.
--
Type::
`object`
Required::
- `href`
- `location`
- `text`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `applicationMenu`
| `object`
| applicationMenu holds information about section and icon used for the link in the
application menu, and it is applicable only when location is set to ApplicationMenu.
| `href`
| `string`
| href is the absolute URL for the link. Must use https:// for web URLs or mailto: for email links.
| `location`
| `string`
| location determines which location in the console the link will be appended to (ApplicationMenu, HelpMenu, UserMenu, NamespaceDashboard).
| `namespaceDashboard`
| `object`
| namespaceDashboard holds information about namespaces in which the dashboard link should
appear, and it is applicable only when location is set to NamespaceDashboard.
If not specified, the link will appear in all namespaces.
| `text`
| `string`
| text is the display text for the link
|===
=== .spec.applicationMenu
Description::
+
--
applicationMenu holds information about section and icon used for the link in the
application menu, and it is applicable only when location is set to ApplicationMenu.
--
Type::
`object`
Required::
- `section`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `imageURL`
| `string`
| imageURL is the URL for the icon used in front of the link in the application menu.
The URL must be an HTTPS URL or a Data URI. The image should be square and will be shown at 24x24 pixels.
| `section`
| `string`
| section is the section of the application menu in which the link should appear.
This can be any text that will appear as a subheading in the application menu dropdown.
A new section will be created if the text does not match text of an existing section.
|===
=== .spec.namespaceDashboard
Description::
+
--
namespaceDashboard holds information about namespaces in which the dashboard link should
appear, and it is applicable only when location is set to NamespaceDashboard.
If not specified, the link will appear in all namespaces.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `namespaceSelector`
| `object`
| namespaceSelector is used to select the Namespaces that should contain dashboard link by label.
If the namespace labels match, dashboard link will be shown for the namespaces.
| `namespaces`
| `array (string)`
| namespaces is an array of namespace names in which the dashboard link should appear.
|===
=== .spec.namespaceDashboard.namespaceSelector
Description::
+
--
namespaceSelector is used to select the Namespaces that should contain dashboard link by label.
If the namespace labels match, dashboard link will be shown for the namespaces.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
|===
=== .spec.namespaceDashboard.namespaceSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--
Type::
`array`
=== .spec.namespaceDashboard.namespaceSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--
Type::
`object`
Required::
- `key`
- `operator`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `key`
| `string`
| key is the label key that the selector applies to.
| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
|===
== API endpoints
The following API endpoints are available:
* `/apis/console.openshift.io/v1/consolelinks`
- `DELETE`: delete collection of ConsoleLink
- `GET`: list objects of kind ConsoleLink
- `POST`: create a ConsoleLink
* `/apis/console.openshift.io/v1/consolelinks/{name}`
- `DELETE`: delete a ConsoleLink
- `GET`: read the specified ConsoleLink
- `PATCH`: partially update the specified ConsoleLink
- `PUT`: replace the specified ConsoleLink
* `/apis/console.openshift.io/v1/consolelinks/{name}/status`
- `GET`: read status of the specified ConsoleLink
- `PATCH`: partially update status of the specified ConsoleLink
- `PUT`: replace status of the specified ConsoleLink
=== /apis/console.openshift.io/v1/consolelinks
HTTP method::
`DELETE`
Description::
delete collection of ConsoleLink
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind ConsoleLink
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-console-v1-ConsoleLinkList[`ConsoleLinkList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create a ConsoleLink
.Query parameters
[cols="1,1,2",options="header"]
|===
| 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.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 201 - Created
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 202 - Accepted
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/console.openshift.io/v1/consolelinks/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ConsoleLink
|===
HTTP method::
`DELETE`
Description::
delete a ConsoleLink
.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified ConsoleLink
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified ConsoleLink
.Query parameters
[cols="1,1,2",options="header"]
|===
| 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.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified ConsoleLink
.Query parameters
[cols="1,1,2",options="header"]
|===
| 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.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 201 - Created
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/console.openshift.io/v1/consolelinks/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ConsoleLink
|===
HTTP method::
`GET`
Description::
read status of the specified ConsoleLink
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified ConsoleLink
.Query parameters
[cols="1,1,2",options="header"]
|===
| 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.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified ConsoleLink
.Query parameters
[cols="1,1,2",options="header"]
|===
| 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.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 201 - Created
| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema
| 401 - Unauthorized
| Empty
|===
View Git Blame Copy Permalink