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

Updated Swagger documentation to match bearer token usage in OSCAR API #259

Merged
merged 1 commit into from
Oct 8, 2024
Merged

Updated Swagger documentation to match bearer token usage in OSCAR API #259

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
15 changes: 14 additions & 1 deletion docs/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ paths:
description: List all created services
security:
- basicAuth: []
- token: []
tags:
- services
post:
Expand All @@ -50,6 +51,7 @@ paths:
description: Create a service
security:
- basicAuth: []
- token: []
requestBody:
content:
application/json:
Expand All @@ -74,6 +76,7 @@ paths:
description: Update a service
security:
- basicAuth: []
- token: []
requestBody:
content:
application/json:
Expand Down Expand Up @@ -108,6 +111,7 @@ paths:
operationId: ReadService
security:
- basicAuth: []
- token: []
description: Read a service
delete:
summary: Delete service
Expand All @@ -124,6 +128,7 @@ paths:
description: Delete a service
security:
- basicAuth: []
- token: []
tags:
- services
'/system/logs/{serviceName}':
Expand Down Expand Up @@ -157,6 +162,7 @@ paths:
operationId: ListJobs
security:
- basicAuth: []
- token: []
description: List all jobs with their status
delete:
summary: Delete jobs
Expand All @@ -173,6 +179,7 @@ paths:
description: Delete all jobs from a service.
security:
- basicAuth: []
- token: []
parameters:
- schema:
type: boolean
Expand Down Expand Up @@ -214,6 +221,7 @@ paths:
description: Get the logs from a job
security:
- basicAuth: []
- token: []
parameters:
- schema:
type: boolean
Expand All @@ -234,6 +242,7 @@ paths:
description: Delete a job
security:
- basicAuth: []
- token: []
tags:
- logs
/system/info:
Expand All @@ -256,6 +265,7 @@ paths:
description: Get system info
security:
- basicAuth: []
- token: []
/health:
get:
summary: Health
Expand Down Expand Up @@ -316,6 +326,7 @@ paths:
description: Get system configuration
security:
- basicAuth: []
- token: []
'/run/{serviceName}':
parameters:
- schema:
Expand Down Expand Up @@ -607,4 +618,6 @@ servers:
- url: 'https://localhost'
description: 'Local testing'
- url: 'https://inference.cloud.ai4eosc.eu'
description: 'AI4EOSC OSCAR cluster'
description: 'AI4EOSC OSCAR cluster'
- url: 'https://inference-walton.cloud.imagine-ai.eu'
description: 'iMagine OSCAR cluster'
Loading