Schematic API — components

naftiko: 1.0.0-alpha2
info:
  label: Schematic API — components
  description: 'Schematic API — components. 7 operations. Lead operation: List components. Self-contained Naftiko capability
    covering one Schematic business surface.'
  tags:
  - Schematic
  - components
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCHEMATIC_API_KEY: SCHEMATIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: schematic-components
    baseUri: https://api.schematichq.com
    description: Schematic API — components business capability. Self-contained, no shared references.
    resources:
    - name: components
      path: /components
      operations:
      - name: listcomponents
        method: GET
        description: List components
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
        - name: limit
          in: query
          type: integer
          description: Page limit (default 100)
        - name: offset
          in: query
          type: integer
          description: Page offset (default 0)
      - name: createcomponent
        method: POST
        description: Create component
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: components-count
      path: /components/count
      operations:
      - name: countcomponents
        method: GET
        description: Count components
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
        - name: limit
          in: query
          type: integer
          description: Page limit (default 100)
        - name: offset
          in: query
          type: integer
          description: Page offset (default 0)
    - name: components-preview-data
      path: /components/preview-data
      operations:
      - name: previewcomponentdata
        method: GET
        description: Preview component data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: company_id
          in: query
          type: string
        - name: component_id
          in: query
          type: string
    - name: components-component_id
      path: /components/{component_id}
      operations:
      - name: getcomponent
        method: GET
        description: Get component
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: component_id
          in: path
          type: string
          description: component_id
          required: true
      - name: updatecomponent
        method: PUT
        description: Update component
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: component_id
          in: path
          type: string
          description: component_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecomponent
        method: DELETE
        description: Delete component
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: component_id
          in: path
          type: string
          description: component_id
          required: true
    authentication:
      type: apikey
      key: X-Schematic-Api-Key
      value: '{{env.SCHEMATIC_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: schematic-components-rest
    port: 8080
    description: REST adapter for Schematic API — components. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/components
      name: components
      description: REST surface for components.
      operations:
      - method: GET
        name: listcomponents
        description: List components
        call: schematic-components.listcomponents
        with:
          q: rest.q
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcomponent
        description: Create component
        call: schematic-components.createcomponent
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/components/count
      name: components-count
      description: REST surface for components-count.
      operations:
      - method: GET
        name: countcomponents
        description: Count components
        call: schematic-components.countcomponents
        with:
          q: rest.q
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/components/preview-data
      name: components-preview-data
      description: REST surface for components-preview-data.
      operations:
      - method: GET
        name: previewcomponentdata
        description: Preview component data
        call: schematic-components.previewcomponentdata
        with:
          company_id: rest.company_id
          component_id: rest.component_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/components/{component-id}
      name: components-component-id
      description: REST surface for components-component_id.
      operations:
      - method: GET
        name: getcomponent
        description: Get component
        call: schematic-components.getcomponent
        with:
          component_id: rest.component_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecomponent
        description: Update component
        call: schematic-components.updatecomponent
        with:
          component_id: rest.component_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecomponent
        description: Delete component
        call: schematic-components.deletecomponent
        with:
          component_id: rest.component_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: schematic-components-mcp
    port: 9090
    transport: http
    description: MCP adapter for Schematic API — components. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-components
      description: List components
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-components.listcomponents
      with:
        q: tools.q
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: create-component
      description: Create component
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: schematic-components.createcomponent
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: count-components
      description: Count components
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-components.countcomponents
      with:
        q: tools.q
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: preview-component-data
      description: Preview component data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-components.previewcomponentdata
      with:
        company_id: tools.company_id
        component_id: tools.component_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-component
      description: Get component
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-components.getcomponent
      with:
        component_id: tools.component_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-component
      description: Update component
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: schematic-components.updatecomponent
      with:
        component_id: tools.component_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-component
      description: Delete component
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: schematic-components.deletecomponent
      with:
        component_id: tools.component_id
      outputParameters:
      - type: object
        mapping: $.