Ampersand public API — Revision

naftiko: 1.0.0-alpha2
info:
  label: Ampersand public API — Revision
  description: 'Ampersand public API — Revision. 2 operations. Lead operation: Ampersand Create a New Revision.. Self-contained
    Naftiko capability covering one Ampersand business surface.'
  tags:
  - Ampersand
  - Revision
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AMPERSAND_API_KEY: AMPERSAND_API_KEY
capability:
  consumes:
  - type: http
    namespace: ampersand-revision
    baseUri: https://api.withampersand.com/v1
    description: Ampersand public API — Revision business capability. Self-contained, no shared references.
    resources:
    - name: projects-projectIdOrName-integrations-integrationId-revisions
      path: /projects/{projectIdOrName}/integrations/{integrationId}/revisions
      operations:
      - name: createrevision
        method: POST
        description: Ampersand Create a New Revision.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: integrationId
          in: path
          type: string
          description: The integration ID.
          required: true
        - name: destructive
          in: query
          type: boolean
          description: Defaults to false. This flag controls whether to perform destructive actions when deploying integrations,
            like pausing all read actions for an object that was r
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-projectIdOrName-integrations-integrationId-revisions-revisionId}:hydrat
      path: /projects/{projectIdOrName}/integrations/{integrationId}/revisions/{revisionId}:hydrate
      operations:
      - name: gethydratedrevision
        method: GET
        description: Ampersand Get a Hydrated Revision
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: integrationId
          in: path
          type: string
          description: The integration ID.
          required: true
        - name: revisionId
          in: path
          type: string
          description: The revision ID. You can find this on the integration object's `latestRevision.id` field.
          required: true
        - name: connectionId
          in: query
          type: string
          description: The ID of the consumer's connection to the SaaS provider. This connection's credentials are used to
            fetch field metadata from the provider's API.
          required: true
    authentication:
      type: bearer
      token: '{{env.AMPERSAND_API_KEY}}'
  exposes:
  - type: rest
    namespace: ampersand-revision-rest
    port: 8080
    description: REST adapter for Ampersand public API — Revision. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects/{projectidorname}/integrations/{integrationid}/revisions
      name: projects-projectidorname-integrations-integrationid-revisions
      description: REST surface for projects-projectIdOrName-integrations-integrationId-revisions.
      operations:
      - method: POST
        name: createrevision
        description: Ampersand Create a New Revision.
        call: ampersand-revision.createrevision
        with:
          projectIdOrName: rest.projectIdOrName
          integrationId: rest.integrationId
          destructive: rest.destructive
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectidorname}/integrations/{integrationid}/revisions/revisionid-hydrate
      name: projects-projectidorname-integrations-integrationid-revisions-revisionid-hydrat
      description: REST surface for projects-projectIdOrName-integrations-integrationId-revisions-revisionId}:hydrat.
      operations:
      - method: GET
        name: gethydratedrevision
        description: Ampersand Get a Hydrated Revision
        call: ampersand-revision.gethydratedrevision
        with:
          projectIdOrName: rest.projectIdOrName
          integrationId: rest.integrationId
          revisionId: rest.revisionId
          connectionId: rest.connectionId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ampersand-revision-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ampersand public API — Revision. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: ampersand-create-new-revision
      description: Ampersand Create a New Revision.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ampersand-revision.createrevision
      with:
        projectIdOrName: tools.projectIdOrName
        integrationId: tools.integrationId
        destructive: tools.destructive
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-get-hydrated-revision
      description: Ampersand Get a Hydrated Revision
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ampersand-revision.gethydratedrevision
      with:
        projectIdOrName: tools.projectIdOrName
        integrationId: tools.integrationId
        revisionId: tools.revisionId
        connectionId: tools.connectionId
      outputParameters:
      - type: object
        mapping: $.