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 #13

Closed
wants to merge 2 commits into from
Closed

Update OpenAPI Specification #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
683cbd4
Update OpenAPI Specification (composio.json)
konfig-bot[bot] Sep 19, 2024
60504ce
add operation IDs
dphuang2 Sep 19, 2024
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
6 changes: 6 additions & 0 deletions .konfig/progress.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ operationIds:
get: ActionsControllerV1_get
/api/v1/actions/{actionId}/execute:
post: ActionsControllerV1_execute
/api/v1/analytics/:
get: Analytics_getData
/api/v1/analytics/top-entities:
get: Analytics_getTopEntities
/api/v1/api_keys:
get: ApiKeys_list
post: ApiKeys_generate
Expand Down Expand Up @@ -239,6 +243,8 @@ securityParameters:
query: false
key:
query: false
lastTimePeriod:
query: false
limit:
query: false
page:
Expand Down
336 changes: 336 additions & 0 deletions composio.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2791,6 +2791,282 @@
}
},
"type": "object"
},
"TimePeriodReqDTO": {
"properties": {
"lastTimePeriod": {
"enum": [
"DAY",
"WEEK",
"MONTH",
"SIX_MONTH",
"YEAR",
"FIVE_YEAR"
],
"type": "string",
"description": "Time period to get the data for"
}
},
"type": "object"
},
"ActionByAppDTO": {
"properties": {
"appName": {
"type": "string",
"description": "Name of the app"
},
"totalCount": {
"type": "number",
"description": "Total count of actions for the app"
}
},
"type": "object",
"required": [
"appName",
"totalCount"
]
},
"ActionByStatusDTO": {
"properties": {
"failed": {
"type": "number",
"description": "Count of failed actions"
},
"success": {
"type": "number",
"description": "Count of successful actions"
}
},
"type": "object",
"required": [
"failed",
"success"
]
},
"ActionAnalyticsDTO": {
"properties": {
"date": {
"type": "string",
"description": "Date of the action",
"format": "date"
},
"byApp": {
"$ref": "#/components/schemas/ActionByAppDTO",
"description": "Action counts by app"
},
"byStatus": {
"$ref": "#/components/schemas/ActionByStatusDTO",
"description": "Action counts by status"
}
},
"type": "object",
"required": [
"date",
"byApp",
"byStatus"
]
},
"IntegrationsWithCountsDTO": {
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the integration"
},
"appName": {
"type": "string",
"description": "Name of the app"
},
"integrationName": {
"type": "string",
"description": "Name of the integration"
},
"connectionCount": {
"type": "number",
"description": "Count of connections for the integration"
},
"triggerCount": {
"type": "number",
"description": "Count of triggers for the integration"
},
"requestLogsCount": {
"type": "number",
"description": "Count of request logs for the integration"
}
},
"type": "object",
"required": [
"id",
"appName",
"integrationName",
"connectionCount",
"triggerCount",
"requestLogsCount"
]
},
"AppNameCountDTO": {
"properties": {
"appName": {
"type": "string",
"description": "Name of the app"
},
"connectionCount": {
"type": "number",
"description": "Count of connections for the app"
},
"triggerCount": {
"type": "number",
"description": "Count of triggers for the app"
},
"requestLogsCount": {
"type": "number",
"description": "Count of request logs for the app"
}
},
"type": "object",
"required": [
"appName",
"connectionCount",
"triggerCount",
"requestLogsCount"
]
},
"AnalyticsDataReqDTO": {
"properties": {
"lastTimePeriod": {
"enum": [
"DAY",
"WEEK",
"MONTH",
"SIX_MONTH",
"YEAR",
"FIVE_YEAR"
],
"type": "string",
"description": "Time period to get the data for"
}
},
"type": "object"
},
"ClientUniqueUserIdCountDTO": {
"properties": {
"clientUniqueUserId": {
"type": "string",
"description": "Client unique user id"
},
"count": {
"type": "number",
"description": "Count of connections for the client unique user id"
}
},
"type": "object",
"required": [
"clientUniqueUserId",
"count"
]
},
"AnalyticsEntityDataDTO": {
"properties": {
"byConnections": {
"items": {
"$ref": "#/components/schemas/ClientUniqueUserIdCountDTO"
},
"type": "array",
"description": "Connection counts by entity"
},
"byActions": {
"items": {
"$ref": "#/components/schemas/ClientUniqueUserIdCountDTO"
},
"type": "array",
"description": "Action counts by entity"
},
"byTriggers": {
"items": {
"$ref": "#/components/schemas/ClientUniqueUserIdCountDTO"
},
"type": "array",
"description": "Trigger counts by entity"
}
},
"type": "object",
"required": [
"byConnections",
"byActions",
"byTriggers"
]
},
"AnalyticsDataResDTO": {
"properties": {
"entity": {
"$ref": "#/components/schemas/AnalyticsEntityDataDTO",
"description": "Entity-related analytics data, providing a breakdown by connections, actions, and triggers for each entity. This is include all entity info."
},
"actions": {
"items": {
"$ref": "#/components/schemas/ActionAnalyticsDTO"
},
"type": "array",
"description": "Detailed action analytics data, offering a breakdown by day, status, and provider for all actions"
},
"trigger": {
"items": {
"$ref": "#/components/schemas/ActionAnalyticsDTO"
},
"type": "array",
"description": "Comprehensive trigger analytics data, presenting a breakdown by day, status, and provider for all triggers"
},
"integrations": {
"items": {
"$ref": "#/components/schemas/IntegrationsWithCountsDTO"
},
"type": "array",
"description": "Detailed integration analytics data, including a breakdown of connection count, trigger count, and request logs count for each integration"
},
"app": {
"$ref": "#/components/schemas/AppNameCountDTO",
"description": "Comprehensive app-level analytics data, providing a breakdown of connection count, trigger count, and request logs count for each app"
}
},
"type": "object",
"required": [
"entity",
"actions",
"trigger",
"integrations",
"app"
]
},
"TopEntitiesResDTO": {
"properties": {
"entities": {
"items": {
"$ref": "#/components/schemas/TConnectionCountDTO"
},
"type": "array",
"description": "Top entities by connection count"
}
},
"type": "object",
"required": [
"entities"
]
},
"TConnectionCountDTO": {
"properties": {
"clientUniqueUserId": {
"type": "string",
"description": "Name of the entity"
},
"count": {
"type": "number",
"description": "Count of connections for the entity"
}
},
"type": "object",
"required": [
"clientUniqueUserId",
"count"
]
}
},
"securitySchemes": {
Expand Down Expand Up @@ -4199,6 +4475,66 @@
],
"description": "Get Trigger Info"
}
},
"/api/v1/analytics/": {
"get": {
"operationId": "getAnalytics",
"parameters": [
{
"in": "query",
"name": "lastTimePeriod",
"schema": {
"enum": [
"DAY",
"WEEK",
"MONTH",
"SIX_MONTH",
"YEAR",
"FIVE_YEAR"
],
"type": "string",
"description": "Time period to get the data for"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsDataResDTO"
}
}
},
"description": ""
}
},
"summary": "Get analytics",
"tags": [
"Analytics"
]
}
},
"/api/v1/analytics/top-entities": {
"get": {
"operationId": "getTopEntities",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TopEntitiesResDTO"
}
}
},
"description": ""
}
},
"summary": "Get top entities",
"tags": [
"Analytics"
]
}
}
},
"security": [
Expand Down
Loading
Loading