Skip to content

Commit cf39a8a

Browse files
authored
fix(openapi): add missing OAuth client registration fields (#2227)
adds missing OAuth client registration fields
1 parent 9a8d0df commit cf39a8a

File tree

1 file changed

+58
-2
lines changed

1 file changed

+58
-2
lines changed

openapi.yaml

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1895,29 +1895,58 @@ paths:
18951895
properties:
18961896
client_name:
18971897
type: string
1898+
description: Human-readable name of the client application
18981899
client_uri:
18991900
type: string
19001901
format: uri
1902+
description: URL of the client application's homepage
1903+
logo_uri:
1904+
type: string
1905+
format: uri
1906+
description: URL of the client application's logo
19011907
redirect_uris:
19021908
type: array
19031909
items:
19041910
type: string
19051911
format: uri
1912+
description: Array of redirect URIs used by the client (maximum 10)
1913+
client_type:
1914+
type: string
1915+
enum:
1916+
- public
1917+
- confidential
1918+
description: >
1919+
Type of the client. Optional. If not provided, will be inferred from token_endpoint_auth_method or defaults to 'confidential'.
1920+
Public clients are used for applications that cannot securely store credentials (e.g., SPAs, mobile apps).
1921+
Confidential clients can securely store credentials (e.g., server-side applications).
1922+
token_endpoint_auth_method:
1923+
type: string
1924+
enum:
1925+
- none
1926+
- client_secret_basic
1927+
- client_secret_post
1928+
description: >
1929+
Authentication method for the token endpoint. Optional.
1930+
'none' is for public clients, 'client_secret_basic' and 'client_secret_post' are for confidential clients.
1931+
If provided, must be consistent with client_type. If not provided, will be inferred from client_type.
19061932
grant_types:
19071933
type: array
19081934
items:
19091935
type: string
19101936
enum:
19111937
- authorization_code
19121938
- refresh_token
1939+
description: OAuth grant types the client will use (defaults to both if not specified)
19131940
response_types:
19141941
type: array
19151942
items:
19161943
type: string
19171944
enum:
19181945
- code
1946+
description: OAuth response types the client can use
19191947
scope:
19201948
type: string
1949+
description: Space-separated list of scope values
19211950
responses:
19221951
201:
19231952
description: OAuth client created
@@ -2055,20 +2084,43 @@ paths:
20552084
type: string
20562085
format: uri
20572086
description: URL of the client application's homepage
2087+
logo_uri:
2088+
type: string
2089+
format: uri
2090+
description: URL of the client application's logo
20582091
redirect_uris:
20592092
type: array
20602093
items:
20612094
type: string
20622095
format: uri
2063-
description: Array of redirect URIs used by the client
2096+
description: Array of redirect URIs used by the client (maximum 10)
2097+
client_type:
2098+
type: string
2099+
enum:
2100+
- public
2101+
- confidential
2102+
description: >
2103+
Type of the client. Optional. If not provided, will be inferred from token_endpoint_auth_method or defaults to 'confidential'.
2104+
Public clients are used for applications that cannot securely store credentials (e.g., SPAs, mobile apps).
2105+
Confidential clients can securely store credentials (e.g., server-side applications).
2106+
token_endpoint_auth_method:
2107+
type: string
2108+
enum:
2109+
- none
2110+
- client_secret_basic
2111+
- client_secret_post
2112+
description: >
2113+
Authentication method for the token endpoint. Optional.
2114+
'none' is for public clients, 'client_secret_basic' and 'client_secret_post' are for confidential clients.
2115+
If provided, must be consistent with client_type. If not provided, will be inferred from client_type.
20642116
grant_types:
20652117
type: array
20662118
items:
20672119
type: string
20682120
enum:
20692121
- authorization_code
20702122
- refresh_token
2071-
description: OAuth grant types the client will use
2123+
description: OAuth grant types the client will use (defaults to both if not specified)
20722124
response_types:
20732125
type: array
20742126
items:
@@ -3003,6 +3055,10 @@ components:
30033055
type: string
30043056
format: uri
30053057
description: URL of the client application's homepage
3058+
logo_uri:
3059+
type: string
3060+
format: uri
3061+
description: URL of the client application's logo
30063062
redirect_uris:
30073063
type: array
30083064
items:

0 commit comments

Comments
 (0)