Skip to content

Commit

Permalink
Updated Swagger documentation to match bearer token usage in OSCAR API
Browse files Browse the repository at this point in the history
  • Loading branch information
gmolto committed Oct 7, 2024
1 parent 1c9e3df commit 8e85614
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/api.yaml
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'

0 comments on commit 8e85614

Please sign in to comment.