Skip to content
← Back to Index

enums/definitions/<name>/categories/<key>

Defines a category for grouping related values within an enum definition. Categories organize values into labeled groups in the Portal UI.

To assign a value to a category, set the setKey property on the value entry.

The schema is the same as local enum categories.

Properties

PropertyTypeDescription
labelobjectLocalized labels for the category. Keys are locale codes (e.g., default, sv-SE, en-US).

Example Value

json
{
  "label": {
    "default": "Express Carriers",
    "sv": "Expressfrakt"
  }
}

Example

yaml
# Define categories
uri: /resources/registry/enums/definitions/shipping-carriers/categories/express
spec:
  value:
    label:
      default: Express Carriers
---
uri: /resources/registry/enums/definitions/shipping-carriers/categories/standard
spec:
  value:
    label:
      default: Standard Carriers
---
# Assign values to categories
uri: /resources/registry/enums/definitions/shipping-carriers/values/dhl-express
spec:
  value:
    label:
      default: DHL Express
    setKey: express
---
uri: /resources/registry/enums/definitions/shipping-carriers/values/postnord
spec:
  value:
    label:
      default: PostNord
    setKey: standard

© 2024 Hantera AB. All rights reserved.