Skip to content

Instantly share code, notes, and snippets.

@sttts

sttts/openapi.json

Created March 6, 2024 19:35
Show Gist options
  • Save sttts/ba1dca85cd99e70b402dead7145ed18b to your computer and use it in GitHub Desktop.
Save sttts/ba1dca85cd99e70b402dead7145ed18b to your computer and use it in GitHub Desktop.
Download ZIP
Raw
openapi.json
{
"openapi": "3.0.0",
"info":
{
"title": "Kubernetes CRD Swagger",
"version": "v0.1.0"
},
"paths":
{
"/apis/spaces.upbound.io/v1beta1/controlplanes":
{
"get":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "list objects of kind ControlPlane",
"operationId": "listSpacesUpboundIoV1beta1ControlPlaneForAllNamespaces",
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlaneList"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlaneList"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "list",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"parameters":
[
{
"name": "allowWatchBookmarks",
"in": "query",
"description": "allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
},
{
"name": "continue",
"in": "query",
"description": "The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldSelector",
"in": "query",
"description": "A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "labelSelector",
"in": "query",
"description": "A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "limit",
"in": "query",
"description": "limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"schema":
{
"type": "integer",
"uniqueItems": true
}
},
{
"name": "pretty",
"in": "query",
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "resourceVersion",
"in": "query",
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "resourceVersionMatch",
"in": "query",
"description": "resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "sendInitialEvents",
"in": "query",
"description": "`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
},
{
"name": "timeoutSeconds",
"in": "query",
"description": "Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"schema":
{
"type": "integer",
"uniqueItems": true
}
},
{
"name": "watch",
"in": "query",
"description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
}
]
},
"/apis/spaces.upbound.io/v1beta1/namespaces/{namespace}/controlplanes":
{
"get":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "list objects of kind ControlPlane",
"operationId": "listSpacesUpboundIoV1beta1NamespacedControlPlane",
"parameters":
[
{
"name": "allowWatchBookmarks",
"in": "query",
"description": "allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
},
{
"name": "continue",
"in": "query",
"description": "The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldSelector",
"in": "query",
"description": "A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "labelSelector",
"in": "query",
"description": "A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "limit",
"in": "query",
"description": "limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"schema":
{
"type": "integer",
"uniqueItems": true
}
},
{
"name": "resourceVersion",
"in": "query",
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "resourceVersionMatch",
"in": "query",
"description": "resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "sendInitialEvents",
"in": "query",
"description": "`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
},
{
"name": "timeoutSeconds",
"in": "query",
"description": "Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"schema":
{
"type": "integer",
"uniqueItems": true
}
},
{
"name": "watch",
"in": "query",
"description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
}
],
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlaneList"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlaneList"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "list",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"post":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "create a ControlPlane",
"operationId": "createSpacesUpboundIoV1beta1NamespacedControlPlane",
"parameters":
[
{
"name": "dryRun",
"in": "query",
"description": "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",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldManager",
"in": "query",
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldValidation",
"in": "query",
"description": "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.",
"schema":
{
"type": "string",
"uniqueItems": true
}
}
],
"requestBody":
{
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
},
"required": true
},
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"201":
{
"description": "Created",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"202":
{
"description": "Accepted",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "post",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"delete":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "delete collection of ControlPlane",
"operationId": "deleteSpacesUpboundIoV1beta1CollectionNamespacedControlPlane",
"parameters":
[
{
"name": "allowWatchBookmarks",
"in": "query",
"description": "allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
},
{
"name": "continue",
"in": "query",
"description": "The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldSelector",
"in": "query",
"description": "A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "labelSelector",
"in": "query",
"description": "A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "limit",
"in": "query",
"description": "limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"schema":
{
"type": "integer",
"uniqueItems": true
}
},
{
"name": "resourceVersion",
"in": "query",
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "resourceVersionMatch",
"in": "query",
"description": "resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "sendInitialEvents",
"in": "query",
"description": "`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
},
{
"name": "timeoutSeconds",
"in": "query",
"description": "Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"schema":
{
"type": "integer",
"uniqueItems": true
}
},
{
"name": "watch",
"in": "query",
"description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
}
],
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "deletecollection",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"parameters":
[
{
"name": "namespace",
"in": "path",
"description": "object name and auth scope, such as for teams and projects",
"required": true,
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "pretty",
"in": "query",
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
"schema":
{
"type": "string",
"uniqueItems": true
}
}
]
},
"/apis/spaces.upbound.io/v1beta1/namespaces/{namespace}/controlplanes/{name}":
{
"get":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "read the specified ControlPlane",
"operationId": "readSpacesUpboundIoV1beta1NamespacedControlPlane",
"parameters":
[
{
"name": "resourceVersion",
"in": "query",
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":
{
"type": "string",
"uniqueItems": true
}
}
],
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "get",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"put":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "replace the specified ControlPlane",
"operationId": "replaceSpacesUpboundIoV1beta1NamespacedControlPlane",
"parameters":
[
{
"name": "dryRun",
"in": "query",
"description": "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",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldManager",
"in": "query",
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldValidation",
"in": "query",
"description": "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.",
"schema":
{
"type": "string",
"uniqueItems": true
}
}
],
"requestBody":
{
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
},
"required": true
},
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"201":
{
"description": "Created",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "put",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"delete":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "delete a ControlPlane",
"operationId": "deleteSpacesUpboundIoV1beta1NamespacedControlPlane",
"parameters":
[
{
"name": "dryRun",
"in": "query",
"description": "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",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "gracePeriodSeconds",
"in": "query",
"description": "The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
"schema":
{
"type": "integer",
"uniqueItems": true
}
},
{
"name": "orphanDependents",
"in": "query",
"description": "Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
},
{
"name": "propagationPolicy",
"in": "query",
"description": "Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
"schema":
{
"type": "string",
"uniqueItems": true
}
}
],
"requestBody":
{
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions"
}
}
}
},
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
}
}
},
"202":
{
"description": "Accepted",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "delete",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"patch":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "partially update the specified ControlPlane",
"operationId": "patchSpacesUpboundIoV1beta1NamespacedControlPlane",
"parameters":
[
{
"name": "dryRun",
"in": "query",
"description": "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",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldManager",
"in": "query",
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldValidation",
"in": "query",
"description": "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.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "force",
"in": "query",
"description": "Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
}
],
"requestBody":
{
"content":
{
"application/apply-patch+yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
}
},
"application/json-patch+json":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
}
},
"application/merge-patch+json":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
}
}
},
"required": true
},
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "patch",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"parameters":
[
{
"name": "name",
"in": "path",
"description": "name of the ControlPlane",
"required": true,
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "namespace",
"in": "path",
"description": "object name and auth scope, such as for teams and projects",
"required": true,
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "pretty",
"in": "query",
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
"schema":
{
"type": "string",
"uniqueItems": true
}
}
]
},
"/apis/spaces.upbound.io/v1beta1/namespaces/{namespace}/controlplanes/{name}/status":
{
"get":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "read status of the specified ControlPlane",
"operationId": "readSpacesUpboundIoV1beta1NamespacedControlPlaneStatus",
"parameters":
[
{
"name": "resourceVersion",
"in": "query",
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":
{
"type": "string",
"uniqueItems": true
}
}
],
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "get",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"put":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "replace status of the specified ControlPlane",
"operationId": "replaceSpacesUpboundIoV1beta1NamespacedControlPlaneStatus",
"parameters":
[
{
"name": "dryRun",
"in": "query",
"description": "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",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldManager",
"in": "query",
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldValidation",
"in": "query",
"description": "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.",
"schema":
{
"type": "string",
"uniqueItems": true
}
}
],
"requestBody":
{
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
},
"required": true
},
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"201":
{
"description": "Created",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "put",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"patch":
{
"tags":
[
"spacesUpboundIo_v1beta1"
],
"description": "partially update status of the specified ControlPlane",
"operationId": "patchSpacesUpboundIoV1beta1NamespacedControlPlaneStatus",
"parameters":
[
{
"name": "dryRun",
"in": "query",
"description": "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",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldManager",
"in": "query",
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "fieldValidation",
"in": "query",
"description": "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.",
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "force",
"in": "query",
"description": "Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.",
"schema":
{
"type": "boolean",
"uniqueItems": true
}
}
],
"requestBody":
{
"content":
{
"application/apply-patch+yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
}
},
"application/json-patch+json":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
}
},
"application/merge-patch+json":
{
"schema":
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
}
}
},
"required": true
},
"responses":
{
"200":
{
"description": "OK",
"content":
{
"application/json":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"application/yaml":
{
"schema":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
}
}
},
"401":
{
"description": "Unauthorized"
}
},
"x-kubernetes-action": "patch",
"x-kubernetes-group-version-kind":
{
"group": "spaces.upbound.io",
"version": "v1beta1",
"kind": "ControlPlane"
}
},
"parameters":
[
{
"name": "name",
"in": "path",
"description": "name of the ControlPlane",
"required": true,
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "namespace",
"in": "path",
"description": "object name and auth scope, such as for teams and projects",
"required": true,
"schema":
{
"type": "string",
"uniqueItems": true
}
},
{
"name": "pretty",
"in": "query",
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
"schema":
{
"type": "string",
"uniqueItems": true
}
}
]
}
},
"components":
{
"schemas":
{
"io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions":
{
"description": "DeleteOptions may be provided when deleting an API object.",
"type": "object",
"properties":
{
"apiVersion":
{
"description": "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",
"type": "string"
},
"dryRun":
{
"description": "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",
"type": "array",
"items":
{
"type": "string",
"default": ""
}
},
"gracePeriodSeconds":
{
"description": "The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
"type": "integer",
"format": "int64"
},
"kind":
{
"description": "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",
"type": "string"
},
"orphanDependents":
{
"description": "Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
"type": "boolean"
},
"preconditions":
{
"description": "Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.",
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions"
}
]
},
"propagationPolicy":
{
"description": "Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
"type": "string"
}
},
"x-kubernetes-group-version-kind":
[
{
"group": "",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "admissionregistration.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "admissionregistration.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha1"
},
{
"group": "admissionregistration.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "apps",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "apps",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "apps",
"kind": "DeleteOptions",
"version": "v1beta2"
},
{
"group": "authentication.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "authentication.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha1"
},
{
"group": "authentication.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "authorization.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "authorization.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "autoscaling",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "autoscaling",
"kind": "DeleteOptions",
"version": "v2"
},
{
"group": "autoscaling",
"kind": "DeleteOptions",
"version": "v2beta1"
},
{
"group": "autoscaling",
"kind": "DeleteOptions",
"version": "v2beta2"
},
{
"group": "batch",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "batch",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "certificates.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "certificates.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha1"
},
{
"group": "certificates.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "coordination.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "coordination.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "discovery.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "discovery.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "events.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "events.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "extensions",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "flowcontrol.apiserver.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "flowcontrol.apiserver.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "flowcontrol.apiserver.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta2"
},
{
"group": "flowcontrol.apiserver.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta3"
},
{
"group": "internal.apiserver.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha1"
},
{
"group": "networking.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "networking.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha1"
},
{
"group": "networking.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "node.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "node.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha1"
},
{
"group": "node.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "policy",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "policy",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "rbac.authorization.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "rbac.authorization.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha1"
},
{
"group": "rbac.authorization.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "resource.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha2"
},
{
"group": "scheduling.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "scheduling.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha1"
},
{
"group": "scheduling.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
},
{
"group": "storage.k8s.io",
"kind": "DeleteOptions",
"version": "v1"
},
{
"group": "storage.k8s.io",
"kind": "DeleteOptions",
"version": "v1alpha1"
},
{
"group": "storage.k8s.io",
"kind": "DeleteOptions",
"version": "v1beta1"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1":
{
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta":
{
"description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
"type": "object",
"properties":
{
"continue":
{
"description": "continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.",
"type": "string"
},
"remainingItemCount":
{
"description": "remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.",
"type": "integer",
"format": "int64"
},
"resourceVersion":
{
"description": "String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink":
{
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry":
{
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"type": "object",
"properties":
{
"apiVersion":
{
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType":
{
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1":
{
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type.",
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1"
}
]
},
"manager":
{
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation":
{
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"subresource":
{
"description": "Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.",
"type": "string"
},
"time":
{
"description": "Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.",
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
}
]
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta":
{
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"type": "object",
"properties":
{
"annotations":
{
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations",
"type": "object",
"additionalProperties":
{
"type": "string",
"default": ""
}
},
"creationTimestamp":
{
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
}
]
},
"deletionGracePeriodSeconds":
{
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"type": "integer",
"format": "int64"
},
"deletionTimestamp":
{
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
}
]
},
"finalizers":
{
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"type": "array",
"items":
{
"type": "string",
"default": ""
},
"x-kubernetes-patch-strategy": "merge"
},
"generateName":
{
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation":
{
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer",
"format": "int64"
},
"labels":
{
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels",
"type": "object",
"additionalProperties":
{
"type": "string",
"default": ""
}
},
"managedFields":
{
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"type": "array",
"items":
{
"default":
{},
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry"
}
]
}
},
"name":
{
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
"type": "string"
},
"namespace":
{
"description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces",
"type": "string"
},
"ownerReferences":
{
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"type": "array",
"items":
{
"default":
{},
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference"
}
]
},
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion":
{
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink":
{
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
"type": "string"
},
"uid":
{
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference":
{
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"type": "object",
"required":
[
"apiVersion",
"kind",
"name",
"uid"
],
"properties":
{
"apiVersion":
{
"description": "API version of the referent.",
"type": "string",
"default": ""
},
"blockOwnerDeletion":
{
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller":
{
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind":
{
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string",
"default": ""
},
"name":
{
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
"type": "string",
"default": ""
},
"uid":
{
"description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
"type": "string",
"default": ""
}
},
"x-kubernetes-map-type": "atomic"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.Patch":
{
"description": "Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.",
"type": "object"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions":
{
"description": "Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.",
"type": "object",
"properties":
{
"resourceVersion":
{
"description": "Specifies the target ResourceVersion",
"type": "string"
},
"uid":
{
"description": "Specifies the target UID.",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.Status":
{
"description": "Status is a return value for calls that don't return other objects.",
"type": "object",
"properties":
{
"apiVersion":
{
"description": "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",
"type": "string"
},
"code":
{
"description": "Suggested HTTP return code for this status, 0 if not set.",
"type": "integer",
"format": "int32"
},
"details":
{
"description": "Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.",
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails"
}
]
},
"kind":
{
"description": "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",
"type": "string"
},
"message":
{
"description": "A human-readable description of the status of this operation.",
"type": "string"
},
"metadata":
{
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"default":
{},
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
]
},
"reason":
{
"description": "A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.",
"type": "string"
},
"status":
{
"description": "Status of the operation. One of: \"Success\" or \"Failure\". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
"type": "string"
}
},
"x-kubernetes-group-version-kind":
[
{
"group": "",
"kind": "Status",
"version": "v1"
},
{
"group": "resource.k8s.io",
"kind": "Status",
"version": "v1alpha2"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause":
{
"description": "StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.",
"type": "object",
"properties":
{
"field":
{
"description": "The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.\n\nExamples:\n \"name\" - the field \"name\" on the current resource\n \"items[0].name\" - the field \"name\" on the first array entry in \"items\"",
"type": "string"
},
"message":
{
"description": "A human-readable description of the cause of the error. This field may be presented as-is to a reader.",
"type": "string"
},
"reason":
{
"description": "A machine-readable description of the cause of the error. If this value is empty there is no information available.",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails":
{
"description": "StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.",
"type": "object",
"properties":
{
"causes":
{
"description": "The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.",
"type": "array",
"items":
{
"default":
{},
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause"
}
]
}
},
"group":
{
"description": "The group attribute of the resource associated with the status StatusReason.",
"type": "string"
},
"kind":
{
"description": "The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name":
{
"description": "The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).",
"type": "string"
},
"retryAfterSeconds":
{
"description": "If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.",
"type": "integer",
"format": "int32"
},
"uid":
{
"description": "UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.Time":
{
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string",
"format": "date-time"
},
"io.upbound.spaces.v1beta1.ControlPlane":
{
"description": "ControlPlane defines a managed Crossplane instance.",
"type": "object",
"required":
[
"spec"
],
"properties":
{
"apiVersion":
{
"description": "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",
"type": "string"
},
"kind":
{
"description": "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",
"type": "string"
},
"metadata":
{
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
}
]
},
"spec":
{
"description": "A ControlPlaneSpec represents the desired state of the ControlPlane.",
"type": "object",
"properties":
{
"backup":
{
"description": "THIS IS AN ALPHA FIELD. Do not use it in production.",
"type": "object",
"properties":
{
"storageLocation":
{
"description": "StorageLocation specifies details about the control planes underlying storage location\nwhere backups are stored or retrieved.",
"type": "object",
"properties":
{
"accessMode":
{
"description": "AccessMode specifies the access mode of the control plane's backup storage location.\nSet to ReadOnly when using restoring an existing control plane to another, so\nthat two control planes aren't backing up to the same location.",
"type": "string",
"default": "ReadWrite",
"enum":
[
"ReadOnly",
"ReadWrite"
]
},
"prefix":
{
"description": "Prefix defines the directory within the control plane's storage location where backups are\nstored or retrieved.",
"type": "string",
"minLength": 1
}
}
}
}
},
"crossplane":
{
"description": "Crossplane defines the configuration for Crossplane.",
"type": "object",
"properties":
{
"autoUpgrade":
{
"description": "AutoUpgrades defines the auto upgrade configuration for Crossplane.",
"type": "object",
"default":
{
"channel": "Stable"
},
"properties":
{
"channel":
{
"description": "Channel defines the upgrade channels for Crossplane. We support the following channels where 'Stable' is the\ndefault:\n- None: disables auto-upgrades and keeps the control plane at its current version of Crossplane.\n- Patch: automatically upgrades the control plane to the latest supported patch version when it\n becomes available while keeping the minor version the same.\n- Stable: automatically upgrades the control plane to the latest supported patch release on minor\n version N-1, where N is the latest supported minor version.\n- Rapid: automatically upgrades the cluster to the latest supported patch release on the latest\n supported minor version.",
"type": "string",
"default": "Stable",
"enum":
[
"None",
"Patch",
"Stable",
"Rapid"
]
}
}
},
"version":
{
"description": "Version is the version of Universal Crossplane to install.",
"type": "string"
}
}
},
"deletionPolicy":
{
"description": "DeletionPolicy specifies what will happen to the underlying external\nresource when this managed resource is deleted - either \"Delete\" or\n\"Orphan\" the external resource.\nThis field is planned to be deprecated in favor of the ManagementPolicy\nfield in a future release. Currently, both could be set independently and\nnon-default values would be honored if the feature flag is enabled.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223",
"type": "string",
"default": "Delete",
"enum":
[
"Orphan",
"Delete"
]
},
"managementPolicies":
{
"description": "THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored\nunless the relevant Crossplane feature flag is enabled, and may be\nchanged or removed without notice.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nThis field is planned to replace the DeletionPolicy field in a future\nrelease. Currently, both could be set independently and non-default\nvalues would be honored if the feature flag is enabled. If both are\ncustom, the DeletionPolicy field will be ignored.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md",
"type": "array",
"default":
[
"*"
],
"items":
{
"description": "A ManagementAction represents an action that the Crossplane controllers\ncan take on an external resource.",
"type": "string",
"enum":
[
"Observe",
"Create",
"Update",
"Delete",
"LateInitialize",
"*"
]
}
},
"publishConnectionDetailsTo":
{
"description": "PublishConnectionDetailsTo specifies the connection secret config which\ncontains a name, metadata and a reference to secret store config to\nwhich any connection details for this managed resource should be written.\nConnection details frequently include the endpoint, username,\nand password required to connect to the managed resource.",
"type": "object",
"required":
[
"name"
],
"properties":
{
"configRef":
{
"description": "SecretStoreConfigRef specifies which secret store config should be used\nfor this ConnectionSecret.",
"type": "object",
"default":
{
"name": "default"
},
"required":
[
"name"
],
"properties":
{
"name":
{
"description": "Name of the referenced object.",
"type": "string"
},
"policy":
{
"description": "Policies for referencing.",
"type": "object",
"properties":
{
"resolution":
{
"description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.",
"type": "string",
"default": "Required",
"enum":
[
"Required",
"Optional"
]
},
"resolve":
{
"description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.",
"type": "string",
"enum":
[
"Always",
"IfNotPresent"
]
}
}
}
}
},
"metadata":
{
"description": "Metadata is the metadata for connection secret.",
"type": "object",
"properties":
{
"annotations":
{
"description": "Annotations are the annotations to be added to connection secret.\n- For Kubernetes secrets, this will be used as \"metadata.annotations\".\n- It is up to Secret Store implementation for others store types.",
"type": "object",
"additionalProperties":
{
"type": "string"
}
},
"labels":
{
"description": "Labels are the labels/tags to be added to connection secret.\n- For Kubernetes secrets, this will be used as \"metadata.labels\".\n- It is up to Secret Store implementation for others store types.",
"type": "object",
"additionalProperties":
{
"type": "string"
}
},
"type":
{
"description": "Type is the SecretType for the connection secret.\n- Only valid for Kubernetes Secret Stores.",
"type": "string"
}
}
},
"name":
{
"description": "Name is the name of the connection secret.",
"type": "string"
}
}
},
"source":
{
"description": "THIS IS AN ALPHA FIELD. Do not use it in production.",
"type": "object",
"required":
[
"git"
],
"properties":
{
"git":
{
"description": "Git is the configuration for a Git repository to pull the Control Plane\nSource from.",
"type": "object",
"required":
[
"auth",
"path",
"pullInterval",
"url"
],
"properties":
{
"auth":
{
"description": "Auth is the authentication configuration to access the Git repository.\nDefault is no authentication.",
"type": "object",
"default":
{
"type": "None"
},
"required":
[
"type"
],
"properties":
{
"basic":
{
"description": "Basic is the configuration for basic authentication, i.e. username and\npassword.",
"type": "object",
"required":
[
"secretRef"
],
"properties":
{
"secretRef":
{
"description": "SecretRef is a reference to a Secret containing the username and password.\nThe secret must contain the keys \"username\" and \"password\".",
"type": "object",
"required":
[
"name",
"namespace"
],
"properties":
{
"name":
{
"description": "Name of the secret.",
"type": "string"
},
"namespace":
{
"description": "Namespace of the secret.",
"type": "string"
}
}
}
}
},
"bearerToken":
{
"description": "BearerToken is the configuration for bearer token authentication.",
"type": "object",
"required":
[
"secretRef"
],
"properties":
{
"secretRef":
{
"description": "SecretRef is a reference to a Secret containing the bearer token.\nThe secret must contain the key \"bearerToken\".",
"type": "object",
"required":
[
"name",
"namespace"
],
"properties":
{
"name":
{
"description": "Name of the secret.",
"type": "string"
},
"namespace":
{
"description": "Namespace of the secret.",
"type": "string"
}
}
}
}
},
"caSecretRef":
{
"description": "CASecretRef is a reference to a Secret containing CA certificates to use\nto verify the Git server's certificate. The secret must contain the key\n\"ca.crt\" where the content is a CA certificate. The type of the secret\ncan be \"Opaque\" or \"kubernetes.io/tls\".",
"type": "object",
"required":
[
"name",
"namespace"
],
"properties":
{
"name":
{
"description": "Name of the secret.",
"type": "string"
},
"namespace":
{
"description": "Namespace of the secret.",
"type": "string"
}
}
},
"ssh":
{
"description": "SSH is the configuration for SSH authentication. Note that the URL must\nuse the SSH protocol (e.g. ssh://github.com/org/repo.git).",
"type": "object",
"required":
[
"secretRef"
],
"properties":
{
"secretRef":
{
"description": "SecretRef is a reference to a Secret containing the SSH key and known\nhosts list.\nThe secret must contain the key \"identity\" where the content is a private\nSSH key. Optionally, it can contain the key \"knownHosts\" where the content\nis a known hosts file.",
"type": "object",
"required":
[
"name",
"namespace"
],
"properties":
{
"name":
{
"description": "Name of the secret.",
"type": "string"
},
"namespace":
{
"description": "Namespace of the secret.",
"type": "string"
}
}
}
}
},
"type":
{
"description": "Type of the authentication to use. Options are: None, Basic\n(username/password), BearerToken, SSH. Default is None. The corresponding\nfields must be set for the chosen authentication type.\n\n\nIf you are looking to use OAuth tokens with popular servers (e.g.\nGitHub, Bitbucket, GitLab) you should use BasicAuth instead of\nBearerToken. These servers use basic HTTP authentication, with the OAuth\ntoken as user or password.\nCheck the documentation of your git server for details.",
"type": "string",
"default": "None",
"enum":
[
"None",
"Basic",
"BearerToken",
"SSH"
]
}
}
},
"path":
{
"description": "Path is the path within the Git repository to pull the Control Plane\nSource from. The folder it points to must contain a valid ControlPlaneSource\nmanifest. Default is the root of the repository.",
"type": "string",
"default": "/",
"minLength": 1
},
"pullInterval":
{
"description": "PullInterval is the interval at which the Git repository should be\npolled for changes. The format is 1h2m3s. Default is 90s. Minimum is 15s.",
"type": "string",
"default": "90s"
},
"ref":
{
"description": "Ref is the git reference to checkout, which can be a branch, tag, or\ncommit SHA. Default is the main branch.",
"type": "object",
"default":
{
"branch": "main"
},
"properties":
{
"branch":
{
"description": "Branch is the git branch to check out.",
"type": "string"
},
"commit":
{
"description": "Commit is the git commit SHA to check out.",
"type": "string"
},
"tag":
{
"description": "Tag is the git tag to check out.",
"type": "string"
}
}
},
"url":
{
"description": "URL is the URL of the Git repository to pull the Control Plane Source.",
"type": "string",
"minLength": 1
}
}
}
}
},
"writeConnectionSecretToRef":
{
"description": "WriteConnectionSecretToReference specifies the namespace and name of a\nSecret to which any connection details for this managed resource should\nbe written. Connection details frequently include the endpoint, username,\nand password required to connect to the managed resource.\nThis field is planned to be replaced in a future release in favor of\nPublishConnectionDetailsTo. Currently, both could be set independently\nand connection details would be published to both without affecting\neach other.\n\n\nIf omitted, it is defaulted to the namespace of the ControlPlane.",
"type": "object",
"required":
[
"name"
],
"properties":
{
"name":
{
"description": "Name of the secret.",
"type": "string"
},
"namespace":
{
"description": "Namespace of the secret. If omitted, it is equal to\nthe namespace of the resource containing this reference as a field.",
"type": "string"
}
}
}
}
},
"status":
{
"description": "A ControlPlaneStatus represents the observed state of a ControlPlane.",
"type": "object",
"properties":
{
"conditions":
{
"description": "Conditions of the resource.",
"type": "array",
"items":
{
"description": "A Condition that may apply to a resource.",
"type": "object",
"required":
[
"lastTransitionTime",
"reason",
"status",
"type"
],
"properties":
{
"lastTransitionTime":
{
"description": "LastTransitionTime is the last time this condition transitioned from one\nstatus to another.",
"type": "string",
"format": "date-time"
},
"message":
{
"description": "A Message containing details about this condition's last transition from\none status to another, if any.",
"type": "string"
},
"reason":
{
"description": "A Reason for this condition's last transition from one status to another.",
"type": "string"
},
"status":
{
"description": "Status of this condition; is it currently True, False, or Unknown?",
"type": "string"
},
"type":
{
"description": "Type of this condition. At most one of each condition type may apply to\na resource at any point in time.",
"type": "string"
}
}
},
"x-kubernetes-list-map-keys":
[
"type"
],
"x-kubernetes-list-type": "map"
},
"controlPlaneID":
{
"type": "string"
},
"hostClusterID":
{
"type": "string"
},
"source":
{
"description": "SourceStatus is the status of the pull and apply operations of resources",
"type": "object",
"properties":
{
"reference":
{
"description": "Reference is the git reference that the Control Plane Source is currently\nchecked out to. This could be a branch, tag or commit SHA.",
"type": "string"
},
"revision":
{
"description": "Revision is always the commit SHA that the Control Plane Source is\ncurrently checked out to.",
"type": "string"
}
}
}
}
}
},
"x-kubernetes-group-version-kind":
[
{
"group": "spaces.upbound.io",
"kind": "ControlPlane",
"version": "v1beta1"
}
]
},
"io.upbound.spaces.v1beta1.ControlPlaneList":
{
"description": "ControlPlaneList is a list of ControlPlane",
"type": "object",
"required":
[
"items"
],
"properties":
{
"apiVersion":
{
"description": "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",
"type": "string"
},
"items":
{
"description": "List of controlplanes. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md",
"type": "array",
"items":
{
"$ref": "#/components/schemas/io.upbound.spaces.v1beta1.ControlPlane"
}
},
"kind":
{
"description": "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",
"type": "string"
},
"metadata":
{
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"allOf":
[
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
]
}
},
"x-kubernetes-group-version-kind":
[
{
"group": "spaces.upbound.io",
"kind": "ControlPlaneList",
"version": "v1beta1"
}
]
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment