exceptionfactory opened a new pull request, #10228:
URL: https://github.com/apache/nifi/pull/10228

   # Summary
   
   [NIFI-14852](https://issues.apache.org/jira/browse/NIFI-14852) Adds Security 
Schemes for HTTP Bearer and session cookie authentication to the OpenAPI 
specification for the NiFi REST API.
   
   The changes set the new security schemes as the default for every operation.
   
   The Access Token and Authentication Configuration operations do not require 
authentication, as indicated with the empty `SecurityRequirements` annotation. 
However, the current version of the Swagger plugin does not render an empty 
`security` element as described in [Swagger Core Issue 
2844](github.com/swagger-api/swagger-core/issues/2844). For this reason, the 
`StandardReader` class implements a custom method to set an empty `List` when 
reading an empty `SecurityRequirements` annotation. This approach renders the 
OpenAPI YAML and JSON as expected for operations that do not require 
authentication.
   
   Additional changes include a new `index.mustache` template for HTML 
rendering. The template follows the same structure as the default template from 
[swagger-codegen](github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/htmlDocs/index.mustache),
 with a custom handling of the `Access` section to provide clear rendering of 
the new Security Schemes.
   
   # Tracking
   
   Please complete the following tracking steps prior to pull request creation.
   
   ### Issue Tracking
   
   - [X] [Apache NiFi Jira](https://issues.apache.org/jira/browse/NIFI) issue 
created
   
   ### Pull Request Tracking
   
   - [X] Pull Request title starts with Apache NiFi Jira issue number, such as 
`NIFI-00000`
   - [X] Pull Request commit message starts with Apache NiFi Jira issue number, 
as such `NIFI-00000`
   
   ### Pull Request Formatting
   
   - [X] Pull Request based on current revision of the `main` branch
   - [X] Pull Request refers to a feature branch with one commit containing 
changes
   
   # Verification
   
   Please indicate the verification steps performed prior to pull request 
creation.
   
   ### Build
   
   - [ ] Build completed using `./mvnw clean install -P contrib-check`
     - [ ] JDK 21
   
   ### Licensing
   
   - [ ] New dependencies are compatible with the [Apache License 
2.0](https://apache.org/licenses/LICENSE-2.0) according to the [License 
Policy](https://www.apache.org/legal/resolved.html)
   - [ ] New dependencies are documented in applicable `LICENSE` and `NOTICE` 
files
   
   ### Documentation
   
   - [ ] Documentation formatting appears as expected in rendered files
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to