Merkl Developer Portal logo
get

/v4/schemas/{groupName}

List schemas in a group (BETA)

List schemas in a group

Returns every entry of the enum backing the given group. Each entry contains the addressable value, the enum key and an optional human-readable description. Use one of these values (or the key) as :typeId in GET /v4/schemas/:groupName/:typeId.

Example: GET /v4/schemas/distributionMethod returns the list of DistributionMethod values for which a JSON Schema is available.

Responds 404 if groupName is not a known group — see GET /v4/schemas for the list of valid groups.

Path parameters

groupNamestring
required

Schema group name

Responses

200
Response for status 200
Schema
object
namestring
required
Schema group name
enumNamestring
required
Underlying enum name
valueTypeenum
required
Type of the discriminator valuesnumberstring
entriesobject[]
required
All schemas available in this group
valuenumber | stringEnum value addressing this schema
keystringEnum key
descriptionstringOptional human-readable description
Example
{
  "name": "string",
  "enumName": "string",
  "valueType": "number",
  "entries": [
    {
      "value": "string",
      "key": "string",
      "description": "string"
    }
  ]
}