{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ampersand public API Key Revision API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Api-Key",
      "value": "{{X-Api-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Revision",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Ampersand Create a New Revision.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.withampersand.com/v1/projects/:projectIdOrName/integrations/:integrationId/revisions",
            "params": [
              {
                "name": "projectIdOrName",
                "value": "my-project",
                "type": "path",
                "description": "The Ampersand project ID or project name."
              },
              {
                "name": "integrationId",
                "value": "",
                "type": "path",
                "description": "The integration ID."
              },
              {
                "name": "destructive",
                "value": "",
                "type": "query",
                "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 removed in the latest revision."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "We recommend using the [CLI's deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case."
        },
        {
          "info": {
            "name": "Ampersand Get a Hydrated Revision",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.withampersand.com/v1/projects/:projectIdOrName/integrations/:integrationId/revisions/:revisionId:hydrate",
            "params": [
              {
                "name": "projectIdOrName",
                "value": "my-project",
                "type": "path",
                "description": "The Ampersand project ID or project name."
              },
              {
                "name": "integrationId",
                "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                "type": "path",
                "description": "The integration ID."
              },
              {
                "name": "revisionId",
                "value": "f0e1d2c3-b4a5-6789-0abc-def123456789",
                "type": "path",
                "description": "The revision ID. You can find this on the integration object's `latestRevision.id` field."
              },
              {
                "name": "connectionId",
                "value": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Returns the integration revision enriched with live field metadata from the consumer's connected SaaS instance, such as available fields, display names, and type for each object defined in the integration.\n"
        }
      ]
    }
  ],
  "bundled": true
}