Sitecore Content Hub REST API — Entities

naftiko: 1.0.0-alpha2
info:
  label: Sitecore Content Hub REST API — Entities
  description: 'Sitecore Content Hub REST API — Entities. 6 operations. Lead operation: List entities. Self-contained Naftiko
    capability covering one Sitecore business surface.'
  tags:
  - Sitecore
  - Entities
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SITECORE_API_KEY: SITECORE_API_KEY
capability:
  consumes:
  - type: http
    namespace: content-hub-rest-entities
    baseUri: https://{tenant}.stylelabs.io/api
    description: Sitecore Content Hub REST API — Entities business capability. Self-contained, no shared references.
    resources:
    - name: entities
      path: /entities
      operations:
      - name: listentities
        method: GET
        description: List entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: definition
          in: query
          type: string
          description: Filter entities by their entity definition identifier
        - name: skip
          in: query
          type: integer
          description: Number of entities to skip for pagination
        - name: take
          in: query
          type: integer
          description: Maximum number of entities to return
        - name: culture
          in: query
          type: string
          description: Culture code for multi-lingual property values (e.g., en-US)
      - name: createentity
        method: POST
        description: Create an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: entities-id
      path: /entities/{id}
      operations:
      - name: getentity
        method: GET
        description: Get an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: culture
          in: query
          type: string
          description: Culture code for localized properties (e.g., en-US)
      - name: updateentity
        method: PUT
        description: Update an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteentity
        method: DELETE
        description: Delete an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: entities-id-lifecycle
      path: /entities/{id}/lifecycle
      operations:
      - name: updateentitylifecycle
        method: PUT
        description: Update entity lifecycle state
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.SITECORE_API_KEY}}'
  exposes:
  - type: rest
    namespace: content-hub-rest-entities-rest
    port: 8080
    description: REST adapter for Sitecore Content Hub REST API — Entities. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/entities
      name: entities
      description: REST surface for entities.
      operations:
      - method: GET
        name: listentities
        description: List entities
        call: content-hub-rest-entities.listentities
        with:
          definition: rest.definition
          skip: rest.skip
          take: rest.take
          culture: rest.culture
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createentity
        description: Create an entity
        call: content-hub-rest-entities.createentity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/entities/{id}
      name: entities-id
      description: REST surface for entities-id.
      operations:
      - method: GET
        name: getentity
        description: Get an entity
        call: content-hub-rest-entities.getentity
        with:
          culture: rest.culture
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateentity
        description: Update an entity
        call: content-hub-rest-entities.updateentity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteentity
        description: Delete an entity
        call: content-hub-rest-entities.deleteentity
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/entities/{id}/lifecycle
      name: entities-id-lifecycle
      description: REST surface for entities-id-lifecycle.
      operations:
      - method: PUT
        name: updateentitylifecycle
        description: Update entity lifecycle state
        call: content-hub-rest-entities.updateentitylifecycle
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: content-hub-rest-entities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sitecore Content Hub REST API — Entities. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-entities
      description: List entities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: content-hub-rest-entities.listentities
      with:
        definition: tools.definition
        skip: tools.skip
        take: tools.take
        culture: tools.culture
      outputParameters:
      - type: object
        mapping: $.
    - name: create-entity
      description: Create an entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: content-hub-rest-entities.createentity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-entity
      description: Get an entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: content-hub-rest-entities.getentity
      with:
        culture: tools.culture
      outputParameters:
      - type: object
        mapping: $.
    - name: update-entity
      description: Update an entity
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: content-hub-rest-entities.updateentity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-entity
      description: Delete an entity
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: content-hub-rest-entities.deleteentity
      outputParameters:
      - type: object
        mapping: $.
    - name: update-entity-lifecycle-state
      description: Update entity lifecycle state
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: content-hub-rest-entities.updateentitylifecycle
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.