Skip to content

docs(openapi): describe the schema fields in the spec #152

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
flemzord merged 2 commits into from
Aug 31, 2026
Merged

docs(openapi): describe the schema fields in the spec #152

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b08a227
docs(openapi): describe the schema fields in the spec
ariel-formance Aug 19, 2026
aa469c2
Update openapi.yaml
ariel-formance Aug 19, 2026
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
22 changes: 22 additions & 0 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,31 +253,39 @@ components:
Metadata:
type: object
nullable: true
description: Arbitrary key/value pairs attached to the resource
additionalProperties:
type: string
ClientOptions:
type: object
properties:
public:
type: boolean
description: Whether the client is public, meaning it cannot keep a secret and uses PKCE instead
redirectUris:
type: array
description: URIs the authorization server may redirect to after a successful authorization
items:
type: string
description:
type: string
description: Human-readable description of the client
name:
type: string
description: Display name of the client
trusted:
type: boolean
description: Whether the client is trusted, skipping the user consent screen
postLogoutRedirectUris:
type: array
description: URIs the authorization server may redirect to after logout
items:
type: string
metadata:
$ref: '#/components/schemas/Metadata'
scopes:
type: array
description: Scopes the client is allowed to request
items:
type: string
required:
Expand All @@ -287,17 +295,21 @@ components:
properties:
lastDigits:
type: string
description: Last digits of the secret. The full plaintext is hidden, and only the last digits are exposed.
name:
type: string
description: Human-readable name identifying the secret
id:
type: string
description: Unique identifier of the secret
metadata:
$ref: '#/components/schemas/Metadata'
required:
- id
- lastDigits
- name
Client:
description: An OAuth2 client registered on the stack
allOf:
- $ref: '#/components/schemas/ClientOptions'
- type: object
Expand All @@ -315,6 +327,7 @@ components:
properties:
label:
type: string
description: Human-readable label for the scope
metadata:
$ref: '#/components/schemas/Metadata'
required:
Expand All @@ -337,11 +350,13 @@ components:
properties:
name:
type: string
description: Human-readable name identifying the secret
metadata:
$ref: '#/components/schemas/Metadata'
required:
- name
Secret:
description: A client secret. The full value is returned only at creation and cannot be retrieved again
allOf:
- $ref: '#/components/schemas/SecretOptions'
- type: object
Expand All @@ -358,15 +373,19 @@ components:
- clear
User:
type: object
description: A user known to the stack's identity provider
properties:
id:
type: string
description: Unique identifier of the user
example: 3bb03708-312f-48a0-821a-e765837dc2c4
subject:
type: string
description: Subject claim identifying the user with the identity provider
example: Jane Doe
email:
type: string
description: Email address of the user
example: user1@orga1.com
CreateClientRequest:
$ref: '#/components/schemas/ClientOptions'
Expand All @@ -380,6 +399,7 @@ components:
properties:
data:
type: array
description: The clients registered on this stack
items:
$ref: '#/components/schemas/Client'
UpdateClientRequest:
Expand Down Expand Up @@ -408,6 +428,7 @@ components:
properties:
data:
type: array
description: The users known to this stack
items:
$ref: '#/components/schemas/User'
ServerInfo:
Expand All @@ -417,3 +438,4 @@ components:
properties:
version:
type: string
description: Version of the auth service