JinwooHwang opened a new pull request, #7946:
URL: https://github.com/apache/geode/pull/7946
## Overview
This PR upgrades the `swagger-annotations` dependency from version 2.2.1 to
2.2.22, bringing in bug fixes, security patches, and improvements to OpenAPI
annotation support for better REST API documentation.
## Changes Made
### Dependency Version Updates
- **swagger-annotations**: `2.2.1` → `2.2.22`
### Files Modified
1.
**build-tools/geode-dependency-management/src/main/groovy/org/apache/geode/gradle/plugins/DependencyConstraints.groovy**
- Updated version constraint: `api(group: 'io.swagger.core.v3', name:
'swagger-annotations', version: '2.2.22')`
2. **boms/geode-all-bom/src/test/resources/expected-pom.xml**
- Updated expected swagger-annotations version in BOM test resources
3. **geode-assembly/src/integrationTest/resources/assembly_content.txt**
- Updated JAR reference: `swagger-annotations-2.2.1.jar` →
`swagger-annotations-2.2.22.jar`
4.
**geode-assembly/src/integrationTest/resources/gfsh_dependency_classpath.txt**
- Updated classpath reference: `swagger-annotations-2.2.1.jar` →
`swagger-annotations-2.2.22.jar`
5.
**geode-server-all/src/integrationTest/resources/dependency_classpath.txt**
- Updated classpath reference: `swagger-annotations-2.2.1.jar` →
`swagger-annotations-2.2.22.jar`
## Validation
### Build Validation
All build tasks completed successfully:
- ✅ `build`
### Test Validation
- ✅ All tests passed with `gradlew test`
## About Swagger Annotations
Swagger Annotations (part of swagger-core) provides Java annotations for
documenting RESTful APIs using the OpenAPI Specification (OAS). It is used in
Apache Geode for REST API documentation in the management and web services
modules, enabling automatic generation of API documentation and improving
developer experience.
## Benefits
- **Bug fixes**: Includes all bug fixes from versions 2.2.2 through 2.2.22
- **Security patches**: Addresses known vulnerabilities in earlier versions
- **Enhanced OpenAPI 3.0 support**: Better compliance with OpenAPI 3.0
specification
- **Improved annotation processing**: More accurate and reliable API
documentation generation
- **Better validation**: Enhanced validation of annotation parameters and
configurations
- **Modern Java compatibility**: Improved support for modern Java versions
## Compatibility
- Fully backward compatible with existing code
- No API changes affecting current usage
- All existing tests pass without modification
- No changes required to existing @Schema, @Operation, or other OpenAPI
annotations
## Release Notes References
For detailed information about changes between versions, see:
- [Swagger Core
Releases](https://github.com/swagger-api/swagger-core/releases)
---
**Note**: This upgrade is part of ongoing dependency maintenance to keep the
project up-to-date with the latest stable versions of its dependencies and
ensure optimal API documentation capabilities.
<!-- Thank you for submitting a contribution to Apache Geode. -->
<!-- In order to streamline review of your contribution we ask that you
ensure you've taken the following steps. -->
### For all changes, please confirm:
- [ ] Is there a JIRA ticket associated with this PR? Is it referenced in
the commit message?
- [x] Has your PR been rebased against the latest commit within the target
branch (typically `develop`)?
- [x] Is your initial contribution a single, squashed commit?
- [x] Does `gradlew build` run cleanly?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
--
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]
