Skip to content

Commit 798e7cc

Browse files
committed
Document API tokens in Swagger
1 parent e3bce11 commit 798e7cc

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

server/src/main/java/invite/SwaggerOpenIdConfig.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,14 @@ OpenAPI customOpenApi(@Value("${spring.security.oauth2.client.provider.oidcng.au
3939
SecurityScheme apiTokensSecurityScheme = new SecurityScheme()
4040
.type(SecurityScheme.Type.APIKEY)
4141
.in(SecurityScheme.In.HEADER)
42-
.name(API_TOKEN_HEADER);
42+
.name(API_TOKEN_HEADER)
43+
.description("User generated API token");
4344

4445
SecurityScheme apiHeaderSecurityScheme = new SecurityScheme()
4546
.type(SecurityScheme.Type.APIKEY)
4647
.in(SecurityScheme.In.HEADER)
47-
.name(API_KEY_HEADER);
48+
.name(API_KEY_HEADER)
49+
.description("CRM authentication");
4850

4951
SecurityScheme basicAuthentication = new SecurityScheme()
5052
.type(SecurityScheme.Type.HTTP)

0 commit comments

Comments
 (0)