Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions api/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1714,6 +1714,56 @@ paths:
application/problem+json:
schema:
$ref: "../problem/problem.yaml#/components/schemas/ApiProblem"
/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:resubscribe:
post:
summary: Reconnect an installation's event subscription
description: |
Restarts subscription setup for an installation whose subscription never finished setting up,
typically after the consumer has reauthenticated and repaired the credential that broke it.

The work runs asynchronously and the response carries no body; follow it through the
installation's operations.

This is a no-op, still returning 200, when the installation has no subscribe configuration,
when its subscription is healthy or already being set up, or when a reconnect is already
running.
operationId: resubscribeInstallation
tags: ["Installation"]
parameters:
- name: projectIdOrName
in: path
required: true
description: The Ampersand project ID or project name.
schema:
type: string
example: my-project
- name: integrationId
in: path
required: true
description: The integration ID.
schema:
type: string
- name: installationId
in: path
required: true
description: The Ampersand installation ID.
schema:
type: string
responses:
'200':
description: Reconnect started, already running, or not needed.
'404':
description: Installation not found
content:
application/problem+json:
schema:
$ref: "../problem/problem.yaml#/components/schemas/ApiProblem"
default:
description: Error
content:
application/problem+json:
schema:
$ref: "../problem/problem.yaml#/components/schemas/ApiProblem"
/projects/{projectIdOrName}/installations:
get:
summary: List installations for a project
Expand Down
65 changes: 65 additions & 0 deletions api/generated/api.bundled.json
Original file line number Diff line number Diff line change
Expand Up @@ -2464,6 +2464,71 @@
}
}
},
"/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:resubscribe": {
"post": {
"summary": "Reconnect an installation's event subscription",
"description": "Restarts subscription setup for an installation whose subscription never finished setting up,\ntypically after the consumer has reauthenticated and repaired the credential that broke it.\n\nThe work runs asynchronously and the response carries no body; follow it through the\ninstallation's operations.\n\nThis is a no-op, still returning 200, when the installation has no subscribe configuration,\nwhen its subscription is healthy or already being set up, or when a reconnect is already\nrunning.\n",
"operationId": "resubscribeInstallation",
"tags": [
"Installation"
],
"parameters": [
{
"name": "projectIdOrName",
"in": "path",
"required": true,
"description": "The Ampersand project ID or project name.",
"schema": {
"type": "string"
},
"example": "my-project"
},
{
"name": "integrationId",
"in": "path",
"required": true,
"description": "The integration ID.",
"schema": {
"type": "string"
}
},
{
"name": "installationId",
"in": "path",
"required": true,
"description": "The Ampersand installation ID.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Reconnect started, already running, or not needed."
},
"404": {
"description": "Installation not found",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ApiProblem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ApiProblem"
}
}
}
}
}
}
},
"/projects/{projectIdOrName}/installations": {
"get": {
"summary": "List installations for a project",
Expand Down
Loading
Loading