Skip to content

Commit

Permalink
feat: Update Swagger (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
flemzord committed Nov 16, 2022
1 parent 986cce4 commit 25268f1
Showing 1 changed file with 38 additions and 10 deletions.
48 changes: 38 additions & 10 deletions swagger.yaml
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
openapi: 3.0.3
openapi: 3.1.0
info:
title: Auth API
contact: {}
version: "AUTH_VERSION"

servers:
- url: https://{organization}.o.formance.cloud/auth
description: Production server
variables:
organization:
description: The organization on which the auth server is located
default: ""

paths:
/clients:
get:
summary: List clients
tags:
- Clients
operationId: listClients
responses:
"200":
Expand All @@ -26,6 +20,8 @@ paths:
$ref: '#/components/schemas/ListClientsResponse'
post:
summary: Create client
tags:
- Clients
operationId: createClient
requestBody:
content:
Expand All @@ -42,6 +38,8 @@ paths:
/clients/{clientId}:
get:
summary: Read client
tags:
- Clients
operationId: readClient
parameters:
- description: Client ID
Expand All @@ -59,6 +57,8 @@ paths:
$ref: '#/components/schemas/ReadClientResponse'
put:
summary: Update client
tags:
- Clients
operationId: updateClient
requestBody:
content:
Expand All @@ -81,6 +81,8 @@ paths:
$ref: '#/components/schemas/UpdateClientResponse'
delete:
summary: Delete client
tags:
- Clients
operationId: deleteClient
parameters:
- description: Client ID
Expand All @@ -95,6 +97,8 @@ paths:
/clients/{clientId}/secrets:
post:
summary: Add a secret to a client
tags:
- Clients
operationId: createSecret
parameters:
- description: Client ID
Expand All @@ -118,6 +122,8 @@ paths:
/clients/{clientId}/secrets/{secretId}:
delete:
summary: Delete a secret from a client
tags:
- Clients
operationId: deleteSecret
parameters:
- description: Client ID
Expand All @@ -138,6 +144,8 @@ paths:
/clients/{clientId}/scopes/{scopeId}:
put:
summary: Add scope to client
tags:
- Clients
operationId: addScopeToClient
parameters:
- description: Client ID
Expand All @@ -157,6 +165,8 @@ paths:
description: Scope added to client
delete:
summary: Delete scope from client
tags:
- Clients
operationId: deleteScopeFromClient
parameters:
- description: Client ID
Expand All @@ -177,6 +187,8 @@ paths:
/scopes:
get:
summary: List scopes
tags:
- Scopes
description: List Scopes
operationId: listScopes
responses:
Expand All @@ -188,6 +200,8 @@ paths:
$ref: '#/components/schemas/ListScopesResponse'
post:
summary: Create scope
tags:
- Scopes
description: Create scope
operationId: createScope
requestBody:
Expand All @@ -205,6 +219,8 @@ paths:
/scopes/{scopeId}:
get:
summary: Read scope
tags:
- Scopes
description: Read scope
operationId: readScope
parameters:
Expand All @@ -223,6 +239,8 @@ paths:
$ref: '#/components/schemas/ReadScopeResponse'
put:
summary: Update scope
tags:
- Scopes
description: Update scope
operationId: updateScope
parameters:
Expand All @@ -246,6 +264,8 @@ paths:
$ref: '#/components/schemas/UpdateScopeResponse'
delete:
summary: Delete scope
tags:
- Scopes
description: Delete scope
operationId: deleteScope
parameters:
Expand All @@ -261,6 +281,8 @@ paths:
/scopes/{scopeId}/transient/{transientScopeId}:
put:
summary: Add a transient scope to a scope
tags:
- Scopes
description: Add a transient scope to a scope
operationId: addTransientScope
parameters:
Expand All @@ -281,6 +303,8 @@ paths:
description: "Scope added"
delete:
summary: Delete a transient scope from a scope
tags:
- Scopes
description: Delete a transient scope from a scope
operationId: deleteTransientScope
parameters:
Expand All @@ -302,6 +326,8 @@ paths:
/users:
get:
summary: List users
tags:
- Users
description: List users
operationId: listUsers
responses:
Expand All @@ -314,6 +340,8 @@ paths:
/users/{userId}:
get:
summary: Read user
tags:
- Users
description: Read user
operationId: readUser
parameters:
Expand Down Expand Up @@ -510,4 +538,4 @@ components:
data:
type: array
items:
$ref: '#/components/schemas/User'
$ref: '#/components/schemas/User'

0 comments on commit 25268f1

Please sign in to comment.