StepZen Admin API — Endpoints

naftiko: 1.0.0-alpha2
info:
  label: StepZen Admin API — Endpoints
  description: 'StepZen Admin API — Endpoints. 4 operations. Lead operation: List Endpoints. Self-contained Naftiko capability
    covering one Stepzen business surface.'
  tags:
  - Stepzen
  - Endpoints
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STEPZEN_API_KEY: STEPZEN_API_KEY
capability:
  consumes:
  - type: http
    namespace: admin-endpoints
    baseUri: https://dashboard.ibm.stepzen.com/api/v1
    description: StepZen Admin API — Endpoints business capability. Self-contained, no shared references.
    resources:
    - name: endpoints
      path: /endpoints
      operations:
      - name: listendpoints
        method: GET
        description: List Endpoints
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createendpoint
        method: POST
        description: Create Endpoint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: endpoints-endpointId
      path: /endpoints/{endpointId}
      operations:
      - name: getendpoint
        method: GET
        description: Get Endpoint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteendpoint
        method: DELETE
        description: Delete Endpoint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STEPZEN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: admin-endpoints-rest
    port: 8080
    description: REST adapter for StepZen Admin API — Endpoints. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/endpoints
      name: endpoints
      description: REST surface for endpoints.
      operations:
      - method: GET
        name: listendpoints
        description: List Endpoints
        call: admin-endpoints.listendpoints
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createendpoint
        description: Create Endpoint
        call: admin-endpoints.createendpoint
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/endpoints/{endpointid}
      name: endpoints-endpointid
      description: REST surface for endpoints-endpointId.
      operations:
      - method: GET
        name: getendpoint
        description: Get Endpoint
        call: admin-endpoints.getendpoint
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteendpoint
        description: Delete Endpoint
        call: admin-endpoints.deleteendpoint
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-endpoints-mcp
    port: 9090
    transport: http
    description: MCP adapter for StepZen Admin API — Endpoints. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-endpoints
      description: List Endpoints
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-endpoints.listendpoints
      outputParameters:
      - type: object
        mapping: $.
    - name: create-endpoint
      description: Create Endpoint
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: admin-endpoints.createendpoint
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-endpoint
      description: Get Endpoint
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-endpoints.getendpoint
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-endpoint
      description: Delete Endpoint
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: admin-endpoints.deleteendpoint
      outputParameters:
      - type: object
        mapping: $.