Management API — Syncs

naftiko: 1.0.0-alpha2
info:
  label: Management API — Syncs
  description: 'Management API — Syncs. 4 operations. Lead operation: Get Syncs. Self-contained Naftiko capability covering
    one Supaglue business surface.'
  tags:
  - Supaglue
  - Syncs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SUPAGLUE_API_KEY: SUPAGLUE_API_KEY
capability:
  consumes:
  - type: http
    namespace: management-syncs
    baseUri: https://api.supaglue.io/mgmt/v2
    description: Management API — Syncs business capability. Self-contained, no shared references.
    resources:
    - name: syncs
      path: /syncs
      operations:
      - name: getsyncs
        method: GET
        description: Get Syncs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cursor
          in: query
          type: string
          description: The pagination cursor value
        - name: page_size
          in: query
          type: string
          description: Number of results to return per page
        - name: customer_id
          in: query
          type: string
          description: The customer ID that uniquely identifies the customer in your application
        - name: provider_name
          in: query
          type: string
          description: The provider name
        - name: object_type
          in: query
          type: string
          description: The object type to filter by
        - name: object
          in: query
          type: string
          description: The object to filter by
        - name: entity_id
          in: query
          type: string
          description: The entity id to filter by
    - name: syncs-_pause
      path: /syncs/_pause
      operations:
      - name: pausesync
        method: POST
        description: Pause sync
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: syncs-_resume
      path: /syncs/_resume
      operations:
      - name: resumesync
        method: POST
        description: Resume sync
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: syncs-_trigger
      path: /syncs/_trigger
      operations:
      - name: triggersync
        method: POST
        description: Trigger sync
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: x-api-key
      value: '{{env.SUPAGLUE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: management-syncs-rest
    port: 8080
    description: REST adapter for Management API — Syncs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/syncs
      name: syncs
      description: REST surface for syncs.
      operations:
      - method: GET
        name: getsyncs
        description: Get Syncs
        call: management-syncs.getsyncs
        with:
          cursor: rest.cursor
          page_size: rest.page_size
          customer_id: rest.customer_id
          provider_name: rest.provider_name
          object_type: rest.object_type
          object: rest.object
          entity_id: rest.entity_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/syncs/pause
      name: syncs-pause
      description: REST surface for syncs-_pause.
      operations:
      - method: POST
        name: pausesync
        description: Pause sync
        call: management-syncs.pausesync
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/syncs/resume
      name: syncs-resume
      description: REST surface for syncs-_resume.
      operations:
      - method: POST
        name: resumesync
        description: Resume sync
        call: management-syncs.resumesync
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/syncs/trigger
      name: syncs-trigger
      description: REST surface for syncs-_trigger.
      operations:
      - method: POST
        name: triggersync
        description: Trigger sync
        call: management-syncs.triggersync
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: management-syncs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Management API — Syncs. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-syncs
      description: Get Syncs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: management-syncs.getsyncs
      with:
        cursor: tools.cursor
        page_size: tools.page_size
        customer_id: tools.customer_id
        provider_name: tools.provider_name
        object_type: tools.object_type
        object: tools.object
        entity_id: tools.entity_id
      outputParameters:
      - type: object
        mapping: $.
    - name: pause-sync
      description: Pause sync
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-syncs.pausesync
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: resume-sync
      description: Resume sync
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-syncs.resumesync
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-sync
      description: Trigger sync
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-syncs.triggersync
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.