get_field_metadata

Contents

get_field_metadata#

Access Pyxis Central Schema field metadata.

Arguments#

type_name | String required

The name of the Type to get metadata for.

field_name | String required

The name of the Type field to get metadata for. For nested fields, use dot notation.

Returns#

response_type | single

response_object | FieldMetadata

Query example

{
  get_field_metadata(type_name: "example", field_name: "example") {
    error {
      detail
      status
    }

    data {
      _id
    }
  }
}