invitations.json•18.5 kB
{
"paths": {
"/v1/teams/{team_name}/invitation": {
"get": {
"tags": ["Invitation"],
"summary": "Get team invitation URL",
"security": [{ "bearerAuth": [] }],
"parameters": [
{ "$ref": "./openapi.json#/components/parameters/teamName" }
],
"responses": {
"200": {
"description": "Invitation URL",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
}
}
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"402": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"406": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
}
}
}
},
"/v1/teams/{team_name}/invitation_regenerator": {
"post": {
"tags": ["Invitation"],
"summary": "Regenerate team invitation URL",
"security": [{ "bearerAuth": [] }],
"parameters": [
{ "$ref": "./openapi.json#/components/parameters/teamName" }
],
"responses": {
"200": {
"description": "New invitation URL",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
}
}
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"402": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"406": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
}
}
}
},
"/v1/teams/{team_name}/invitations": {
"get": {
"tags": ["Invitation"],
"summary": "List pending invitations",
"security": [{ "bearerAuth": [] }],
"parameters": [
{ "$ref": "./openapi.json#/components/parameters/teamName" }
],
"responses": {
"200": {
"description": "List of pending invitations",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"invitations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"code": {
"type": "string"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
}
}
}
}
},
"allOf": [
{ "$ref": "./openapi.json#/components/schemas/Pagination" }
]
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"402": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"406": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
}
}
},
"post": {
"tags": ["Invitation"],
"summary": "Send email invitations",
"security": [{ "bearerAuth": [] }],
"parameters": [
{ "$ref": "./openapi.json#/components/parameters/teamName" }
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["member"],
"properties": {
"member": {
"type": "object",
"required": ["emails"],
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string",
"format": "email"
},
"maxItems": 100
}
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Created invitations",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"invitations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"code": {
"type": "string"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
}
}
}
}
}
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"402": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"406": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
}
}
}
},
"/v1/teams/{team_name}/invitations/{code}": {
"delete": {
"tags": ["Invitation"],
"summary": "Delete an invitation",
"security": [{ "bearerAuth": [] }],
"parameters": [
{ "$ref": "./openapi.json#/components/parameters/teamName" },
{
"name": "code",
"in": "path",
"required": true,
"schema": { "type": "string" }
}
],
"responses": {
"204": { "description": "Invitation deleted" },
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"402": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"406": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "./openapi.json#/components/schemas/ErrorResponseBody"
}
}
}
}
}
}
}
}
}