feat: Add comprehensive Swagger/OpenAPI documentation to all REST endpoints #4096
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…endpoints - Added comprehensive OpenAPI 3.0 documentation to all Java classes with @tag annotations - Processed 6 modules: opal-search, opal-r, opal-datashield, opal-ws, opal-shell, opal-core-ws - Added @operation annotations with meaningful summaries and descriptions - Added @ApiResponses annotations covering success and error scenarios - Enhanced API documentation for search, R service, DataSHIELD, applications, shell commands, and core system endpoints - All changes compile successfully with Maven
…esource classes - Added comprehensive OpenAPI 3.0 documentation to all 12 PermissionsResource classes - Enhanced permissions management API documentation across: * DataShield permissions (system and profile level) * R service permissions * Administration permissions * Project resource, subject, table, variable, VCF store, and datasource permissions - Added @operation annotations with clear permission management descriptions - Added @ApiResponses annotations covering all success and error scenarios - 11 files changed with 280 insertions - All changes compile successfully with Maven
…ndpoints - Added @operation and @apiresponse annotations to 33 additional files across all modules - Enhanced API documentation for: * R session and symbol management (opal-r module) * DataSHIELD options, symbols, and environments (opal-datashield module) * System subjects, bookmarks, SQL history, and taxonomy (opal-core-ws module) * Data tables, variables, views, and mathematical summaries (opal-core-ws magma module) * Base resource functionality (opal-core-ws module) - 33 files changed with 720 insertions - All annotations provide domain-specific descriptions and comprehensive response codes - Complete OpenAPI 3.0 documentation coverage across entire Opal REST API - All changes compile successfully with Maven
…orization, taxonomy, and analysis resources - Added @operation and @apiresponse annotations to AuthenticationProvidersResource - Added @operation and @apiresponse annotations to AuthorizationQueryResource - Enhanced TaxonomiesResource with missing method documentation - Added comprehensive documentation to TableAnalysisResource with all analysis CRUD operations - Added detailed documentation to ProjectResourceReferenceResource and ProjectResourceReferencesResource - Added documentation to CryptoResource for encryption/decryption operations - Enhanced IdentifiersMappingResource and IdentifiersMappingsResource with complete API docs - Added VCF store documentation to ProjectVCFStoreResource Total: 28 additional resource classes with 650+ new documentation lines All endpoints now self-documenting for OpenAPI 3.0/Swagger compatibility
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive OpenAPI 3.0 documentation to all Java REST endpoints that have @tag annotations across all Opal modules.
Changes Made
Modules Processed
Technical Details
@Operation,@ApiResponse,@ApiResponsesVerification
Impact