×

Specification

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

spec is an optional field that defines the desired state of the ClusterExtension.

status

object

status is an optional field that defines the observed state of the ClusterExtension.

.spec

Description

spec is an optional field that defines the desired state of the ClusterExtension.

Type

object

Required
  • revision

Property Type Description

lifecycleState

string

Specifies the lifecycle state of the ClusterExtensionRevision.

phases

array

Phases are groups of objects that will be applied at the same time. All objects in the phase will have to pass their probes in order to progress to the next phase.

phases[]

object

ClusterExtensionRevisionPhase are groups of objects that will be applied at the same time. All objects in the a phase will have to pass their probes in order to progress to the next phase.

previous

array

Previous references previous revisions that objects can be adopted from.

previous[]

object

revision

integer

Revision is a sequence number representing a specific revision of the ClusterExtension instance. Must be positive. Each ClusterExtensionRevision of the same parent ClusterExtension needs to have a unique value assigned. It is immutable after creation. The new revision number must always be previous revision +1.

.spec.phases

Description

Phases are groups of objects that will be applied at the same time. All objects in the phase will have to pass their probes in order to progress to the next phase.

Type

array

.spec.phases[]

Description

ClusterExtensionRevisionPhase are groups of objects that will be applied at the same time. All objects in the a phase will have to pass their probes in order to progress to the next phase.

Type

object

Required
  • name

  • objects

Property Type Description

name

string

Name identifies this phase.

objects

array

Objects are a list of all the objects within this phase.

objects[]

object

ClusterExtensionRevisionObject contains an object and settings for it.

.spec.phases[].objects

Description

Objects are a list of all the objects within this phase.

Type

array

.spec.phases[].objects[]

Description

ClusterExtensionRevisionObject contains an object and settings for it.

Type

object

Required
  • object

Property Type Description

collisionProtection

string

CollisionProtection controls whether OLM can adopt and modify objects already existing on the cluster or even owned by another controller.

object

``

.spec.previous

Description

Previous references previous revisions that objects can be adopted from.

Type

array

.spec.previous[]

Description
Type

object

Required
  • name

  • uid

Property Type Description

name

string

uid

string

UID is a type that holds unique ID values, including UUIDs. Because we don’t ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

.status

Description

status is an optional field that defines the observed state of the ClusterExtension.

Type

object

Property Type Description

conditions

array

conditions[]

object

Condition contains details for one aspect of the current state of this API Resource.

.status.conditions

Description
Type

array

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource.

Type

object

Required
  • lastTransitionTime

  • message

  • reason

  • status

  • type

Property Type Description

lastTransitionTime

string

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status

string

status of the condition, one of True, False, Unknown.

type

string

type of condition in CamelCase or in foo.example.com/CamelCase.

API endpoints

The following API endpoints are available:

  • /apis/olm.operatorframework.io/v1/clusterextensionrevisions

    • DELETE: delete collection of ClusterExtensionRevision

    • GET: list objects of kind ClusterExtensionRevision

    • POST: create a ClusterExtensionRevision

  • /apis/olm.operatorframework.io/v1/clusterextensionrevisions/{name}

    • DELETE: delete a ClusterExtensionRevision

    • GET: read the specified ClusterExtensionRevision

    • PATCH: partially update the specified ClusterExtensionRevision

    • PUT: replace the specified ClusterExtensionRevision

  • /apis/olm.operatorframework.io/v1/clusterextensionrevisions/{name}/status

    • GET: read status of the specified ClusterExtensionRevision

    • PATCH: partially update status of the specified ClusterExtensionRevision

    • PUT: replace status of the specified ClusterExtensionRevision

/apis/olm.operatorframework.io/v1/clusterextensionrevisions

HTTP method

DELETE

Description

delete collection of ClusterExtensionRevision

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list objects of kind ClusterExtensionRevision

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

ClusterExtensionRevisionList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create a ClusterExtensionRevision

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

ClusterExtensionRevision schema

Table 5. HTTP responses
HTTP code Reponse body

200 - OK

ClusterExtensionRevision schema

201 - Created

ClusterExtensionRevision schema

202 - Accepted

ClusterExtensionRevision schema

401 - Unauthorized

Empty

/apis/olm.operatorframework.io/v1/clusterextensionrevisions/{name}

Table 6. Global path parameters
Parameter Type Description

name

string

name of the ClusterExtensionRevision

HTTP method

DELETE

Description

delete a ClusterExtensionRevision

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 ClusterExtensionRevision

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

ClusterExtensionRevision schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified ClusterExtensionRevision

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

ClusterExtensionRevision schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified ClusterExtensionRevision

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

ClusterExtensionRevision schema

Table 14. HTTP responses
HTTP code Reponse body

200 - OK

ClusterExtensionRevision schema

201 - Created

ClusterExtensionRevision schema

401 - Unauthorized

Empty

/apis/olm.operatorframework.io/v1/clusterextensionrevisions/{name}/status

Table 15. Global path parameters
Parameter Type Description

name

string

name of the ClusterExtensionRevision

HTTP method

GET

Description

read status of the specified ClusterExtensionRevision

Table 16. HTTP responses
HTTP code Reponse body

200 - OK

ClusterExtensionRevision schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified ClusterExtensionRevision

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

ClusterExtensionRevision schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified ClusterExtensionRevision

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

ClusterExtensionRevision schema

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

ClusterExtensionRevision schema

201 - Created

ClusterExtensionRevision schema

401 - Unauthorized

Empty