Skip to content
OtterScale

Discovery

POST
/otterscale.resource.v1.ResourceService/Discovery

Discovery retrieves the available API resources in the specified cluster.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Connect-Protocol-Version
required
Connect-Protocol-Version

Define the version of the Connect protocol

number
Allowed values: 1
Connect-Timeout-Ms
Connect-Timeout-Ms

Define the timeout, in ms

number

Request Body required

Section titled “Request Body required ”
DiscoveryRequest

DiscoveryRequest defines the parameters for discovering API resources.

object
cluster
cluster

The target Kubernetes cluster identifier.

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

DiscoveryResponse

DiscoveryResponse contains the list of available API resources in the cluster.

object
apiResources
api_resources

The list of available API resources in the cluster.

Array<object>
APIResource

APIResource represents a Kubernetes API resource with its metadata.

object
group
group

Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources).

string
version
version

Kubernetes API Version (e.g., “v1”).

string
resource
resource

Resource name in plural (e.g., “pods”, “deployments”).

string
kind
kind

The kind of the resource (e.g., “Pod”, “Deployment”).

string
namespaced
namespaced

Whether this resource is namespace-scoped.

boolean
verbs
verbs

The list of supported verbs (e.g., “get”, “list”, “create”, “delete”).

Array<string>
shortNames
short_names

Abbreviated aliases for the resource (e.g., “deploy” for deployments).

Array<string>

default

Section titled “default ”

Error

Connect Error
object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string
Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

object
type

A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.

string
value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary
debug
One of: discriminator: type
Any

Detailed error information.

object
key
additional properties
any
key
additional properties
any
key
additional properties
any