Get Filter Schema

GET

/vault/v1/filterSchemas/{resource}

curl --request GET \
  --url https://example.com/vault/v1/filterSchemas/example

Returns the query surface of a single resource.

Parameters

Path Parameters

resource

required

string

Resource

The resource token whose query surface to return, as listed by ListFilterSchemas (for example bucket).

Responses

200

OK

Media type application/json

VaultResourceFilterSchema

The complete query surface of one resource — every field its List operation accepts in filter and order_by.

object

resource

Resource

The resource token this schema describes, as used in the request path.

stringOutput only

version

Version

The contract version this query surface belongs to.

stringOutput only

fields

Fields

Every filterable field of the resource, ordered by name.

Array<object>Output only

VaultFilterFieldSchema

One field of a resource’s query surface: the token a caller may use in a filter expression, its value type, whether it may also be used in order_by, and the comparison operators it accepts.

object

name

Name

The field token as it appears in a filter or order_by expression (for example status or cpu.topology.threads_per_core).

stringOutput only

value_type

Value Type

The type a literal compared against this field must have. One of string, integer, long, double, decimal, boolean, uuid, timestamp.

stringOutput only

sortable

Sortable

Whether this field may appear in an order_by expression. When sort_depends_on_filter is non-empty the sort is accepted only if the request’s filter pins each named field to a single value.

booleanOutput only

repeated_field

Repeated Field

Whether the field holds a list of values. A repeated field is matched with the containment operator and is never sortable.

booleanOutput only

operators

Operators

The comparison operators accepted for this field. Presence (field:*) is accepted for every field and is not listed here.

Array<string>Output only

sort_depends_on_filter

Sort Depends On Filter

Field names whose values the request’s filter must each pin to a single value before this field may be used in order_by. Empty for an unconditional sort.

Array<string>Output only

valid_values

Valid Values

The closed set of values this field accepts, when it has one. Empty means any value of value_type is accepted — never that the vocabulary is unknown. A value outside this set is rejected with INVALID_ARGUMENT.

Array<string>Output only

Example ^generated

{}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

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

integer format: int32

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 a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}