spring enabler doc update

docs/diagrams/apiml-oidc-auth-seq.puml

@@ -4,32 +4,40 @@
 autonumber
 actor User
 actor "User Agent" as Agent
-actor "Client App" as Client
 actor OIDC as OIDC
 actor "API ML GW" as GW
 
 User -> Agent: Do stuff
-Agent -> Client: Open Client App
-Client -> OIDC: Initiate OIDC flow [client_id, client_secret]
-loop [MFA]
+Agent -> GW: /gateway/oauth2/authorization/<provider-id>
+GW -> OIDC: Initiate OIDC flow [client_id, client_secret]
+group MFA
 OIDC -> Agent: Request user credentials
 User <-> Agent: Provide credentials
 Agent -> OIDC: Validate credentials
 end
-OIDC --> Client: Return Auth Code / JWTs[access,refresh,identity]
-Client -> GW: Request resources [JWT AT]
-group validate
-GW -> GW: Validate AT
-GW -> OIDC: Validate AT
-end
-alt Validation success
-GW -> GW: Cache AT validity
+OIDC --> GW: Return Auth Code / JWTs[access,refresh,identity]
+GW -> Agent: Set-cookie access token
+Agent -> GW: Request resources [access token]
+GW -> GW: Validate access token
+GW -> GW: Cache access token validity
+group map user
 GW -> SAF: Map distributed ID to mainframe ID
+end
+alt mapping success
 GW -> GW: Create Zowe JWT
-GW -> Service: call API service
-Service --> GW: return Response
+GW -> Service: Call API service with Zowe JWT
+Service -> Service: Validate JWT
+Service --> GW: Return Response
+autonumber 14 1
+else mapping failure
+
+GW -> Service: call API service with access token
+note left: Step 13 Create Zowe JWT was skipped
+Service -> Service: Validate access token
+Service --> GW: Return Response
 end
-GW --> Client: Response
-Client --> Agent: Response
+autonumber 17 1
+GW --> Agent: Response
+
 
 @enduml

docs/extend/extend-apiml/custom-metadata.md

@@ -105,6 +105,18 @@ Optionally, service can specify which origins will be accepted by Gateway during
 * **customMetadata.apiml.lb.cacheRecordExpirationTimeInHours**  
 When the property `customMetadata.apiml.lb.type` is set to `authentication`, the user can also define the expiration time for the selected instance information that is cached. This property aims to prevent any discrepancy which might occur if the required target server is no longer available. The default value is 8 hours.   
 
+* **customMetadata.apiml.gateway.applyRateLimiterFilter**  
+This parameter specifies the services that the rater limiter is applied to. When enabling this filter, you can also define the following properties:
+  * `customMetadata.apiml.gateway.rateLimiterCapacity`  
+  Defines the total number of requests that can be allowed at one time per user
+  * `customMetadata.apiml.gateway.rateLimiterTokens`  
+  Defines the number of requests that are added to the service’s allowance at regular intervals
+  * `customMetadata.apiml.gateway.rateLimiterRefillDuration`  
+  Sets the time interval (in minutes) at which new requests (or tokens) are added.
+
+  When no values are provided, global values defined in the Gateway are applied. For more information about the default configuration, see [Customizing gateway rate limiter filer](../../user-guide/api-mediation/customizing-gateway-rate-limiter.md).
+
+
 * **customMetadata.apiml.response.compress**  
 When this parameter is set to `true`, API ML compresses content for all responses from this services using GZIP. API ML also adds the `Content-Encoding` header with value `gzip` to responses.
 

docs/extend/extend-apiml/onboard-spring-boot-enabler.md

@@ -95,45 +95,15 @@ Use the following procedure to use _Gradle_ as your build automation system.
 
     Use the corresponding artifact according to the Zowe APIML version you are using.
 
-    - For Zowe APIML versions greater than 1.23.5 use the following artifact:
+    - Use the latest version of the following artifact:
 
         ```groovy
         implementation "org.zowe.apiml.sdk:onboarding-enabler-spring:$zoweApimlVersion"
         ```
 
-    - For Zowe APIML version 1.23.5 use the following artifact:
-
-        ```groovy
-        implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v2-springboot-2.3.12.RELEASE:$zoweApimlVersion"
-        ```
-
-    - For Zowe APIML versions 1.22.3, 1.22.4, and 1.23.0 - 1.23.4 use the following artifact:
-
-        ```groovy
-        implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v2-springboot-2.3.11.RELEASE:$zoweApimlVersion"
-        ```
-
-    - For Zowe APIML versions 1.21.6 - 1.21.13 and 1.22.0 - 1.22.2 use the following artifact:
-
-        ```groovy
-        implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v2-springboot-2.3.9.RELEASE:$zoweApimlVersion"
-        ```
-
-    - For Zowe APIML versions earlier than 1.21.6 that use Spring 2.1.1 use the following artifact:
-
-        ```groovy
-        implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v2-springboot-2.1.1.RELEASE:$zoweApimlVersion"
-        ```
-
-    - For Zowe APIML versions earlier than 1.21.6 that use Spring 1.5.9 use the following artifact:
-
-        ```groovy
-        implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v1-springboot-1.5.9.RELEASE:$zoweApimlVersion"
-        ```
-
     **Notes:**
     * You may need to add additional dependencies as required by your service implementation.
-    * The information provided in this file is valid for `ZoweApimlVersion 1.3.0` and above.
+    * Replace `zoweApimlVersion` with the latest update of the major version according to your Zowe installation.
 
 5. In your project home directory, run the `gradle clean build` command to build your project. Alternatively, you can run `gradlew` to use the specific gradle version that is working with your project.
 
@@ -161,7 +131,7 @@ Use the following procedure if you use _Maven_ as your build automation system.
 
 2. Add the proper dependencies
 
-    - For Zowe APIML versions greater than 1.23.5 use the following artifact:
+    - Use the latest version of the following artifact:
 
         ```XML
         <dependency>
@@ -170,56 +140,9 @@ Use the following procedure if you use _Maven_ as your build automation system.
             <version>$zoweApimlVersion</version>
         </dependency>
         ```
+   **Notes:**
+    * Replace `zoweApimlVersion` with the latest update of the major version according to your Zowe installation.
 
-    - For Zowe APIML version 1.23.5 use the following artifact:
-
-        ```XML
-        <dependency>
-            <groupId>org.zowe.apiml.sdk</groupId>
-            <artifactId>onboarding-enabler-spring-v2-springboot-2.3.12.RELEASE</artifactId>
-            <version>$zoweApimlVersion</version>
-        </dependency>
-        ```
-
-    - For Zowe APIML versions 1.22.3, 1.22.4, and 1.23.0 - 1.23.4 use the following artifact:
-
-        ```XML
-        <dependency>
-            <groupId>org.zowe.apiml.sdk</groupId>
-            <artifactId>onboarding-enabler-spring-v2-springboot-2.3.11.RELEASE</artifactId>
-            <version>$zoweApimlVersion</version>
-        </dependency>
-        ```
-
-    - For Zowe APIML versions 1.21.6 - 1.21.13 and 1.22.0 - 1.22.2 use the following artifact:
-
-        ```XML
-        <dependency>
-            <groupId>org.zowe.apiml.sdk</groupId>
-            <artifactId>onboarding-enabler-spring-v2-springboot-2.3.9.RELEASE</artifactId>
-            <version>$zoweApimlVersion</version>
-        </dependency>
-        ```
-
-    - For Zowe APIML versions earlier than 1.21.6 that use Spring 2.1.1 use the following artifact:
-
-        ```XML
-        <dependency>
-            <groupId>org.zowe.apiml.sdk</groupId>
-            <artifactId>onboarding-enabler-spring-v2-springboot-2.1.1.RELEASE</artifactId>
-            <version>$zoweApimlVersion</version>
-        </dependency>
-        ```
-
-    - For Zowe APIML versions earlier than 1.21.6 that use Spring 1.5.9 use the following artifact:
-
-        ```XML
-        <dependency>
-            <groupId>org.zowe.apiml.sdk</groupId>
-            <artifactId>onboarding-enabler-spring-v1-springboot-1.5.9.RELEASE</artifactId>
-            <version>$zoweApimlVersion</version>
-        </dependency>
-        ```
 
 3. In the directory of your project, run the `mvn clean package` command to build the project.
 
@@ -374,12 +297,12 @@ apiml:
             -   apiId: zowe.apiml.sampleservice
                 version: 1.0.0
                 gatewayUrl: api/v1
-                swaggerUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port}${apiml.service.contextPath}/api-doc
+                swaggerUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port}${apiml.service.contextPath}/v3/api-docs/apiv1
                 documentationUrl: https://www.zowe.org
             -   apiId: zowe.apiml.sampleservice
                 version: 2.0.0
                 gatewayUrl: api/v2
-                swaggerUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port}${apiml.service.contextPath}/api-doc?group=apiv2
+                swaggerUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port}${apiml.service.contextPath}/v3/api-docs/apiv2
                 documentationUrl: https://www.zowe.org
 
         catalog:
@@ -393,8 +316,8 @@ apiml:
             ## This part configures the http client that connects to Discovery Service. You might reuse your server.ssl.xxx properties that configure your application's servlet.
             enabled: true
             verifySslCertificatesOfServices: true
-            protocol: TLSv1.2
-            enabled-protocols: TLSv1.2
+            protocol: TLSv1.3
+            enabled-protocols: TLSv1.3
             keyStoreType: ${fill.your.keystoretype}
             trustStoreType: ${fill.your.truststoretype}
 
@@ -495,92 +418,89 @@ Use the following procedure to add Swagger API documentation to your project.
     * For _Gradle_, add the following dependency in `build.gradle`:
 
         ```groovy
-        compile "io.springfox:springfox-swagger2:2.9.2"
+        implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.2'
         ```
 
-    * For _Maven_, add the following dependency in `pom.xml`:
+      * For _Maven_, add the following dependency in `pom.xml`:
 
-        ```xml
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-swagger2</artifactId>
-            <version>2.9.2</version>
-        </dependency>
-        ```
+          ```xml
+          <dependency>
+             <groupId>org.springdoc</groupId>
+             <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+             <version>2.8.2</version>
+          </dependency>
+          ```
 
 2. Add a Spring configuration class to your project.
 
    **Example:**
 
     ```java
-    package org.zowe.apiml.sampleservice.configuration;
 
+    package org.zowe.apiml.sampleservice.configuration;
+
+    import io.swagger.v3.oas.models.Components;
+    import io.swagger.v3.oas.models.OpenAPI;
+    import io.swagger.v3.oas.models.info.Info;
+    import io.swagger.v3.oas.models.security.SecurityScheme;
+    import org.springdoc.core.models.GroupedOpenApi;
+    import org.springframework.beans.factory.annotation.Value;
     import org.springframework.context.annotation.Bean;
     import org.springframework.context.annotation.Configuration;
-    import org.springframework.web.servlet.config.annotation.EnableWebMvc;
-    import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
-    import springfox.documentation.builders.PathSelectors;
-    import springfox.documentation.builders.RequestHandlerSelectors;
-    import springfox.documentation.service.ApiInfo;
-    import springfox.documentation.service.Contact;
-    import springfox.documentation.spi.DocumentationType;
-    import springfox.documentation.spring.web.plugins.Docket;
-    import springfox.documentation.swagger2.annotations.EnableSwagger2;
-
-    import java.util.ArrayList;
-
+
     @Configuration
-    @EnableSwagger2
-    @EnableWebMvc
-    public class SwaggerConfiguration extends WebMvcConfigurerAdapter {
+    public class SwaggerConfiguration {
+
+        @Value("${apiml.service.title}")
+        private String apiTitle;
+
+        @Value("${apiml.service.apiInfo[0].version}")
+        private String apiVersionRest1;
+
+        @Value("${apiml.service.apiInfo[1].version}")
+        private String graphqlVersion;
+
+        @Value("${apiml.service.apiInfo[2].version}")
+        private String apiVersionRest2;
+
+        @Value("${apiml.service.description}")
+        private String apiDescription;
+
         @Bean
-        public Docket api() {
-            return new Docket(DocumentationType.SWAGGER_2)
-                .select()
-                .apis(RequestHandlerSelectors.any())
-                .paths(PathSelectors.ant("/api/v1/**"))
-                .build()
-                .apiInfo(new ApiInfo(
-                    "Spring REST API",
-                    "Example of REST API",
-                    "1.0.0",
-                    null,
-                    null,
-                    null,
-                    null,
-                    new ArrayList<>()
-                ));
+        public OpenAPI openAPI() {
+            return new OpenAPI()
+                .info(new Info()
+                    .title("Spring REST API")
+                    .description("Example of REST API"))
+                .components(new Components().addSecuritySchemes("ESM token",
+                    new SecurityScheme().type(SecurityScheme.Type.APIKEY).in(SecurityScheme.In.HEADER).name("esmToken"))
+                );
         }
-
+
+        @Bean
+        public GroupedOpenApi apiV1() {
+            return GroupedOpenApi.builder()
+                .group("apiv1")
+                .pathsToMatch("/api/v1/**")
+                .addOpenApiCustomizer(openApi -> openApi.setInfo(openApi.getInfo().version("1.0.0")))
+                .build();
+        }
+
         @Bean
-        public Docket apiv2() {
-            return new Docket(DocumentationType.SWAGGER_2)
-                .groupName("apiv2")
-                .select()
-                .apis(RequestHandlerSelectors.any())
-                .paths(PathSelectors.ant("/api/v2/**"))
-                .build()
-                .apiInfo(new ApiInfo(
-                    "Spring REST API",
-                    "Example of REST API",
-                    "1.0.0",
-                    null,
-                    null,
-                    null,
-                    null,
-                    new ArrayList<>()
-                ));
+        public GroupedOpenApi apiV2() {
+            return GroupedOpenApi.builder()
+                .group("apiv2")
+                .pathsToMatch("/api/v2/**")
+                .addOpenApiCustomizer(openApi -> openApi.setInfo(openApi.getInfo().version("2.0.0")))
+                .build();
         }
+
     }
+
     ```
 
 3. Customize this configuration according to your specifications. For more information about customization properties,
-see [Springfox documentation](https://springfox.github.io/springfox/docs/snapshot/#configuring-springfox).
-
-:::note
-The current SpringFox Version 2.9.2 does not support OpenAPI 3.0.
-For more information about the open feature request see this [issue](https://github.com/springfox/springfox/issues/2022).
-:::
+see [Springdoc configuration](https://springdoc.org/#properties).
 
 ## Validating the discoverability of your API service by the Discovery Service
 

docs/extend/zowe-conformance-program.md

@@ -19,7 +19,7 @@ The [Zowe Conformance Program Explained](https://medium.com/zowe/zowe-conformanc
 
 To participate in the Zowe Conformance Program, follow the process on the [Zowe Conformance Program website](https://openmainframeproject.org/our-projects/zowe-conformance-program/). You can also find a list of products that have earned Zowe Conformant status.  
 
-To learn the criteria of achieving Zowe conformance for an offering, see [Zowe Conformance Criteria](https://github.com/openmainframeproject/foundation/tree/master/zowe_conformance).
+To learn the criteria of achieving Zowe conformance for an offering, see [Zowe Conformance Criteria](https://github.com/openmainframeproject/foundation/blob/main/zowe_conformance/test_evaluation_guide_table.md).
 
 ## How to suggest updates to the Zowe conformance program