Skip to content

Dev to Stage #120

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

Merged
MashB merged 7 commits into from
Feb 27, 2025
Merged

Dev to Stage #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f4f42bb
regenrate api key endpoint
MashB Feb 20, 2025
971b135
API Endpoint for TASK-1720
sujata-m Feb 20, 2025
0679a50
Merge pull request #117 from TaskarCenterAtUW/feature-1720
sujata-m Feb 20, 2025
69befed
Updated request params
sujata-m Feb 20, 2025
6042192
Merge pull request #118 from TaskarCenterAtUW/feature-1720
sujata-m Feb 20, 2025
b62a526
Updated Service Metric API description
sujata-m Feb 21, 2025
e791683
Merge pull request #119 from TaskarCenterAtUW/bugfix-1720
sujata-m Feb 21, 2025
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
29 changes: 29 additions & 0 deletions tdei-api-gateway-prod.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,35 @@
}
}
},
"/api/v1/regenerate-api-key": {
"post": {
"tags": [
"Authentication"
],
"summary": "Regenerates the API key for the user.",
"description": "Regenerates the API key for the user. The old API key will be invalidated and a new API key will be generated.",
"operationId": "regenerateApiKey",
"responses": {
"200": {
"description": "Regeneration of API key successful - Returns the new API key.",
"content": {
"text/plain": {}
}
},
"401": {
"description": "Unauthenticated request. Check your access token."
},
"500": {
"description": "An Internal server error occured"
}
},
"security": [
{
"AuthorizationToken": []
}
]
}
},
"/api/v1/datasets": {
"get": {
"tags": [
Expand Down
29 changes: 29 additions & 0 deletions tdei-api-gateway-stage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,35 @@
}
}
},
"/api/v1/regenerate-api-key": {
"post": {
"tags": [
"Authentication"
],
"summary": "Regenerates the API key for the user.",
"description": "Regenerates the API key for the user. The old API key will be invalidated and a new API key will be generated.",
"operationId": "regenerateApiKey",
"responses": {
"200": {
"description": "Regeneration of API key successful - Returns the new API key.",
"content": {
"text/plain": {}
}
},
"401": {
"description": "Unauthenticated request. Check your access token."
},
"500": {
"description": "An Internal server error occured"
}
},
"security": [
{
"AuthorizationToken": []
}
]
}
},
"/api/v1/datasets": {
"get": {
"tags": [
Expand Down
171 changes: 171 additions & 0 deletions tdei-api-gateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,35 @@
}
}
},
"/api/v1/regenerate-api-key": {
"post": {
"tags": [
"Authentication"
],
"summary": "Regenerates the API key for the user.",
"description": "Regenerates the API key for the user. The old API key will be invalidated and a new API key will be generated.",
"operationId": "regenerateApiKey",
"responses": {
"200": {
"description": "Regeneration of API key successful - Returns the new API key.",
"content": {
"text/plain": {}
}
},
"401": {
"description": "Unauthenticated request. Check your access token."
},
"500": {
"description": "An Internal server error occurred"
}
},
"security": [
{
"AuthorizationToken": []
}
]
}
},
"/api/v1/datasets": {
"get": {
"tags": [
Expand Down Expand Up @@ -3172,6 +3201,62 @@
]
}
},
"/api/v1/service-metrics/{tdei_project_group_id}": {
"get": {
"tags": [
"Metrics"
],
"summary": "Gets the Service metrics",
"description": "This endpoint provides detailed metrics about dataset categorized by Service within the chosen Project Group. It includes the total number of datasets and their cumulative size in megabytes.",
"operationId": "service-metrics",
"parameters": [
{
"name": "tdei_project_group_id",
"in": "path",
"description": "Project Group id of the dataset.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response - Returns the service metrics.",
"content": {
"application/json": {
"schema": {
"title": "ServiceMetricsResponse",
"type": "object",
"$ref": "#/components/schemas/ServiceMetrics",
"description": "Holds the response data"
}
}
}
},
"401": {
"description": "Unauthenticated request"
},
"400": {
"description": "Invalid project group id."
},
"404": {
"description": "Not found error."
},
"500": {
"description": "Internal server error."
}
},
"security": [
{
"ApiKey": []
},
{
"AuthorizationToken": []
}
]
}
},
"/api/v1/recover-password": {
"post": {
"tags": [
Expand Down Expand Up @@ -4070,6 +4155,38 @@
"required": [
"totalUploads"
]
},
"apiCalls": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"byApi": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0
}
},
"required": [
"endpoint",
"count"
]
}
}
},
"required": [
"total",
"byApi"
]
}
}
},
Expand Down Expand Up @@ -4172,6 +4289,60 @@
"dataMetrics",
"datasetMetrics"
]
},
"ServiceMetrics": {
"type": "object",
"properties": {
"project_group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"services": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_id": {
"type": "string",
"format": "uuid"
},
"service_name": {
"type": "string"
},
"dataset_count": {
"type": "integer",
"minimum": 0
},
"total_unzipped_size_mb": {
"type": "number",
"minimum": 0
}
},
"required": [
"service_id",
"service_name",
"dataset_count",
"total_unzipped_size_mb"
]
}
}
},
"required": [
"project_group",
"services"
]
}
},
"securitySchemes": {
Expand Down
Loading