Added CRM endpoints to Swagger

Author: oharsta

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

@@ -11,6 +11,7 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.filter.ForwardedHeaderFilter;
 
+import static invite.security.SecurityConfig.API_KEY_HEADER;
 import static invite.security.SecurityConfig.API_TOKEN_HEADER;
 
 @Configuration
@@ -20,6 +21,7 @@ public class SwaggerOpenIdConfig {
     public static final String OPEN_ID_SCHEME_NAME = "openId";
     public static final String API_TOKENS_SCHEME_NAME = "apiTokens";
     public static final String BASIC_AUTHENTICATION_SCHEME_NAME = "basic_auth";
+    public static final String API_HEADER_SCHEME_NAME = "apiHeaders";
 
     @Bean
     OpenAPI customOpenApi(@Value("${spring.security.oauth2.client.provider.oidcng.authorization-uri}") String authorizationUrl,
@@ -39,13 +41,19 @@ OpenAPI customOpenApi(@Value("${spring.security.oauth2.client.provider.oidcng.au
                 .in(SecurityScheme.In.HEADER)
                 .name(API_TOKEN_HEADER);
 
+        SecurityScheme apiHeaderSecurityScheme = new SecurityScheme()
+                .type(SecurityScheme.Type.APIKEY)
+                .in(SecurityScheme.In.HEADER)
+                .name(API_KEY_HEADER);
+
         SecurityScheme basicAuthentication = new SecurityScheme()
                 .type(SecurityScheme.Type.HTTP)
                 .scheme("basic");
 
         Components components = new Components()
                 .addSecuritySchemes(OPEN_ID_SCHEME_NAME, openIdSecuritySchema)
                 .addSecuritySchemes(API_TOKENS_SCHEME_NAME, apiTokensSecurityScheme)
+                .addSecuritySchemes(API_HEADER_SCHEME_NAME, apiHeaderSecurityScheme)
                 .addSecuritySchemes(BASIC_AUTHENTICATION_SCHEME_NAME, basicAuthentication);
 
         OpenAPI openAPI = new OpenAPI()
@@ -59,6 +67,7 @@ OpenAPI customOpenApi(@Value("${spring.security.oauth2.client.provider.oidcng.au
         openAPI.components(components)
                 .addSecurityItem(new SecurityRequirement().addList(OPEN_ID_SCHEME_NAME))
                 .addSecurityItem(new SecurityRequirement().addList(API_TOKENS_SCHEME_NAME))
+                .addSecurityItem(new SecurityRequirement().addList(API_HEADER_SCHEME_NAME))
                 .addSecurityItem(new SecurityRequirement().addList(BASIC_AUTHENTICATION_SCHEME_NAME));
         return openAPI;
     }

server/src/main/java/invite/crm/CRMController.java

@@ -27,6 +27,8 @@
 import invite.repository.InvitationRepository;
 import invite.repository.RoleRepository;
 import invite.repository.UserRepository;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.jspecify.annotations.NonNull;
@@ -50,11 +52,13 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import static invite.SwaggerOpenIdConfig.API_HEADER_SCHEME_NAME;
 import static invite.api.InvitationOperations.identityProviderName;
 
 @RestController
 @RequestMapping(value = {"/api/internal/v1/crm"}, produces = MediaType.APPLICATION_JSON_VALUE)
 @Transactional
+@SecurityRequirement(name = API_HEADER_SCHEME_NAME)
 public class CRMController {
 
     private static final Log LOG = LogFactory.getLog(CRMController.class);
@@ -108,6 +112,8 @@ public CRMController(@Value("${crm.collab-person-prefix}") String collabPersonPr
     }
 
     @PostMapping("")
+    @Operation(summary = "Create, update CRM role memberships",
+            description = "Add or delete the CRM roles to the CRM contact")
     public ResponseEntity<String> contact(@RequestBody CRMContact crmContact) {
         LOG.debug("POST /api/external/v1/crm: " + crmContact);
 
@@ -127,6 +133,8 @@ public ResponseEntity<String> contact(@RequestBody CRMContact crmContact) {
     }
 
     @DeleteMapping("")
+    @Operation(summary = "Delete CRM profile",
+            description = "Delete CRM profile")
     public ResponseEntity<String> delete(@RequestBody CRMContact crmContact) {
         LOG.debug("DELETE /api/external/v1/crm: " + crmContact);
 

server/src/main/resources/application.yml

@@ -222,7 +222,9 @@ manage:
 #  staticManageDirectory: file:///usr/local/etc/manage
 
 springdoc:
-  pathsToMatch: "/api/external/v1/**"
+  pathsToMatch:
+    - "/api/external/v1/**"
+    - "/api/internal/v1/crm"
   api-docs:
     enabled: true
     path: "/ui/api-docs"