Schematic API — planmigrations

naftiko: 1.0.0-alpha2
info:
  label: Schematic API — planmigrations
  description: 'Schematic API — planmigrations. 5 operations. Lead operation: List company migrations. Self-contained Naftiko
    capability covering one Schematic business surface.'
  tags:
  - Schematic
  - planmigrations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCHEMATIC_API_KEY: SCHEMATIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: schematic-planmigrations
    baseUri: https://api.schematichq.com
    description: Schematic API — planmigrations business capability. Self-contained, no shared references.
    resources:
    - name: plan-version-company-migrations
      path: /plan-version-company-migrations
      operations:
      - name: listcompanymigrations
        method: GET
        description: List company migrations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: migration_id
          in: query
          type: string
        - name: q
          in: query
          type: string
        - name: status
          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: plan-version-company-migrations-count
      path: /plan-version-company-migrations/count
      operations:
      - name: countcompanymigrations
        method: GET
        description: Count company migrations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: migration_id
          in: query
          type: string
        - name: q
          in: query
          type: string
        - name: status
          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: plan-version-migrations
      path: /plan-version-migrations
      operations:
      - name: listmigrations
        method: GET
        description: List migrations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: plan_version_id
          in: query
          type: string
        - name: status
          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: plan-version-migrations-count
      path: /plan-version-migrations/count
      operations:
      - name: countmigrations
        method: GET
        description: Count migrations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: plan_version_id
          in: query
          type: string
        - name: status
          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: plan-version-migrations-plan_version_migration_id
      path: /plan-version-migrations/{plan_version_migration_id}
      operations:
      - name: getmigration
        method: GET
        description: Get migration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: plan_version_migration_id
          in: path
          type: string
          description: plan_version_migration_id
          required: true
    authentication:
      type: apikey
      key: X-Schematic-Api-Key
      value: '{{env.SCHEMATIC_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: schematic-planmigrations-rest
    port: 8080
    description: REST adapter for Schematic API — planmigrations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/plan-version-company-migrations
      name: plan-version-company-migrations
      description: REST surface for plan-version-company-migrations.
      operations:
      - method: GET
        name: listcompanymigrations
        description: List company migrations
        call: schematic-planmigrations.listcompanymigrations
        with:
          migration_id: rest.migration_id
          q: rest.q
          status: rest.status
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/plan-version-company-migrations/count
      name: plan-version-company-migrations-count
      description: REST surface for plan-version-company-migrations-count.
      operations:
      - method: GET
        name: countcompanymigrations
        description: Count company migrations
        call: schematic-planmigrations.countcompanymigrations
        with:
          migration_id: rest.migration_id
          q: rest.q
          status: rest.status
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/plan-version-migrations
      name: plan-version-migrations
      description: REST surface for plan-version-migrations.
      operations:
      - method: GET
        name: listmigrations
        description: List migrations
        call: schematic-planmigrations.listmigrations
        with:
          plan_version_id: rest.plan_version_id
          status: rest.status
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/plan-version-migrations/count
      name: plan-version-migrations-count
      description: REST surface for plan-version-migrations-count.
      operations:
      - method: GET
        name: countmigrations
        description: Count migrations
        call: schematic-planmigrations.countmigrations
        with:
          plan_version_id: rest.plan_version_id
          status: rest.status
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/plan-version-migrations/{plan-version-migration-id}
      name: plan-version-migrations-plan-version-migration-id
      description: REST surface for plan-version-migrations-plan_version_migration_id.
      operations:
      - method: GET
        name: getmigration
        description: Get migration
        call: schematic-planmigrations.getmigration
        with:
          plan_version_migration_id: rest.plan_version_migration_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: schematic-planmigrations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Schematic API — planmigrations. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-company-migrations
      description: List company migrations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-planmigrations.listcompanymigrations
      with:
        migration_id: tools.migration_id
        q: tools.q
        status: tools.status
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: count-company-migrations
      description: Count company migrations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-planmigrations.countcompanymigrations
      with:
        migration_id: tools.migration_id
        q: tools.q
        status: tools.status
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: list-migrations
      description: List migrations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-planmigrations.listmigrations
      with:
        plan_version_id: tools.plan_version_id
        status: tools.status
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: count-migrations
      description: Count migrations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-planmigrations.countmigrations
      with:
        plan_version_id: tools.plan_version_id
        status: tools.status
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: get-migration
      description: Get migration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-planmigrations.getmigration
      with:
        plan_version_migration_id: tools.plan_version_migration_id
      outputParameters:
      - type: object
        mapping: $.