OpenAPI Specification
openapi: 3.0.3
info:
title: Orchestrator Admin Settings S3 API
description: 'API for the GPUaaS Orchestrator microservice. Handles tenants, clusters, VMs,
storage, networking, catalogs, quotas, and related infrastructure operations.
'
version: 1.0.0
contact:
name: GPUaaS Platform
servers:
- url: /
description: Relative base (prefix with deployment base URL)
security:
- bearerAuth: []
tags:
- name: S3
paths:
/tenants/{tenant}/s3/buckets:
get:
tags:
- S3
summary: List S3 buckets
parameters:
- name: tenant
in: path
required: true
schema:
type: string
responses:
'200':
description: List of buckets
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
post:
tags:
- S3
summary: Create S3 bucket
parameters:
- name: tenant
in: path
required: true
schema:
type: string
responses:
'200':
description: Bucket created
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'201':
$ref: '#/components/responses/Created'
'409':
$ref: '#/components/responses/Conflict'
/tenants/{tenant}/s3/buckets/{bucketName}:
get:
tags:
- S3
summary: Get S3 bucket
parameters:
- name: tenant
in: path
required: true
schema:
type: string
- name: bucketName
in: path
required: true
schema:
type: string
responses:
'200':
description: Bucket
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
tags:
- S3
summary: Delete S3 bucket
parameters:
- name: tenant
in: path
required: true
schema:
type: string
- name: bucketName
in: path
required: true
schema:
type: string
responses:
'200':
description: Deleted
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'204':
$ref: '#/components/responses/NoContent'
/tenants/{tenant}/s3/buckets/{bucketName}/files:
get:
tags:
- S3
summary: List files in bucket
parameters:
- name: tenant
in: path
required: true
schema:
type: string
- name: bucketName
in: path
required: true
schema:
type: string
responses:
'200':
description: List of files
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
post:
tags:
- S3
summary: Upload file to bucket
parameters:
- name: tenant
in: path
required: true
schema:
type: string
- name: bucketName
in: path
required: true
schema:
type: string
responses:
'200':
description: File uploaded
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'201':
$ref: '#/components/responses/Created'
'409':
$ref: '#/components/responses/Conflict'
delete:
tags:
- S3
summary: Delete file(s) from bucket
parameters:
- name: tenant
in: path
required: true
schema:
type: string
- name: bucketName
in: path
required: true
schema:
type: string
responses:
'200':
description: Deleted
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'204':
$ref: '#/components/responses/NoContent'
/tenants/{tenant}/s3/buckets/{bucketName}/file:
get:
tags:
- S3
summary: Download file from bucket
parameters:
- name: tenant
in: path
required: true
schema:
type: string
- name: bucketName
in: path
required: true
schema:
type: string
responses:
'200':
description: File content
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/tenants/{tenant}/s3/upload/status/{task_id}:
get:
tags:
- S3
summary: Get upload status
parameters:
- name: tenant
in: path
required: true
schema:
type: string
- name: task_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Upload status
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
components:
responses:
NoContent:
description: No Content - success with no response body
InternalServerError:
description: Internal Server Error - server error
Unauthorized:
description: Unauthorized - missing or invalid authentication
BadRequest:
description: Bad Request - invalid or malformed request
Conflict:
description: Conflict - resource conflict (e.g. duplicate)
NotFound:
description: Not Found - resource does not exist
Forbidden:
description: Forbidden - insufficient permissions
Created:
description: Created - resource created successfully
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT from auth middleware