Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update OpenAPI Specification #52

Closed
wants to merge 1 commit into from
Closed

Update OpenAPI Specification #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
270 changes: 267 additions & 3 deletions composio.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"id": {
"type": "string"
},
"clientId": {
"projectId": {
"type": "string"
},
"email": {
Expand Down Expand Up @@ -60,7 +60,7 @@
"type": "object",
"required": [
"id",
"clientId",
"projectId",
"email",
"name",
"role",
Expand Down Expand Up @@ -191,13 +191,18 @@
"email": {
"type": "string",
"description": "The email associated with the client"
},
"orgId": {
"type": "string",
"description": "The organization ID associated with the client"
}
},
"type": "object",
"required": [
"clientId",
"apiKey",
"email"
"email",
"orgId"
]
},
"UserGitUserInfo": {
Expand Down Expand Up @@ -375,6 +380,50 @@
"apiKey"
]
},
"ProjectReqDTO": {
"properties": {
"name": {
"type": "string",
"description": "The name of the project"
}
},
"type": "object",
"required": [
"name"
]
},
"ProjectResDTO": {
"properties": {
"id": {
"type": "string",
"description": "The ID of the project"
},
"name": {
"type": "string",
"description": "The name of the project"
}
},
"type": "object",
"required": [
"id",
"name"
]
},
"ProjectListResDTO": {
"properties": {
"items": {
"items": {
"type": "object"
},
"type": "array",
"description": "The list of projects"
}
},
"type": "object",
"required": [
"items"
]
},
"InviteMemberReqDTO": {
"properties": {
"email": {
Expand Down Expand Up @@ -2163,6 +2212,72 @@
"totalPages"
]
},
"AdvancedUseCaseSearchQueryDTO": {
"properties": {
"useCase": {
"type": "string"
},
"limit": {
"type": "number"
},
"maxActionsPerTask": {
"type": "number"
},
"minActionsPerTask": {
"type": "number"
},
"apps": {
"type": "string"
},
"filterByAvailableApps": {
"type": "boolean"
}
},
"type": "object",
"required": [
"useCase"
]
},
"AdvancedUseCaseSearchTask": {
"properties": {
"app": {
"type": "string"
},
"actions": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"order": {
"type": "number"
}
},
"type": "object",
"required": [
"app",
"actions",
"description",
"order"
]
},
"AdvancedUseCaseSearchResponse": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/AdvancedUseCaseSearchTask"
},
"type": "array"
}
},
"type": "object",
"required": [
"items"
]
},
"ExecuteActionResDTO": {
"properties": {
"response_data": {
Expand Down Expand Up @@ -3844,6 +3959,83 @@
"description": "Get client info"
}
},
"/api/v1/client/auth/project/add": {
"post": {
"operationId": "_addProject",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectReqDTO"
}
}
},
"description": "ProjectReqDTO",
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {}
},
"description": "Successful response"
}
},
"summary": "Add project",
"tags": [
"Auth"
]
}
},
"/api/v1/client/auth/project/delete/{projectId}": {
"delete": {
"operationId": "_deleteProject",
"parameters": [
{
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"pattern": "[^\\/#\\?]+?",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {}
},
"description": "Successful response"
}
},
"summary": "Delete project",
"tags": [
"Auth"
]
}
},
"/api/v1/client/auth/projects": {
"get": {
"operationId": "_getProjects",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectListResDTO"
}
}
},
"description": ""
}
},
"summary": "Get projects",
"tags": [
"Auth"
]
}
},
"/api/v1/api_keys": {
"post": {
"operationId": "_generateAPIKey",
Expand Down Expand Up @@ -5715,6 +5907,78 @@
"description": "Execute an action with direct auth."
}
},
"/api/v2/actions/search/advanced": {
"get": {
"operationId": "_advancedUseCaseSearch",
"parameters": [
{
"in": "query",
"name": "useCase",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "maxActionsPerTask",
"required": false,
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "minActionsPerTask",
"required": false,
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "apps",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filterByAvailableApps",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvancedUseCaseSearchResponse"
}
}
},
"description": ""
}
},
"summary": "Advanced use case search",
"tags": [
"Actions"
],
"description": "Perform use case search."
}
},
"/api/v2/triggers/{triggerName}": {
"get": {
"operationId": "_getTriggerInfoV2",
Expand Down
Loading