feature/Add core models and access control for resource documentation #2
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
- Introduced `AccessChecker` for enforcing access checks based on user roles and operation IDs. - Added core model classes: `ApiRole`, `ErrorDoc`, `HttpMethod`, `RequestContext`, `RequiredRole`, `ResourceDocJson`, and `Tag`. - Implemented registries for resource documentation and roles with `ResourceDocRegistry` and `RoleRegistry`. - Developed exporters for Markdown and JSON formats: `MarkdownExporter`, `OBPLikeJsonExporter`, and `OpenApiLikeJsonExporter`. - Included tests for resource documentation structure and exporter functionality.
…s documentation and configuration files
…ing checks - Introduced `.scalafmt.conf` for consistent code formatting with scalafmt version 3.7.17. - Updated CI workflow to include formatting checks for all Scala versions. - Added sbt-scalafmt plugin to project dependencies for formatting enforcement. - Refactored comments in various model files for improved clarity and consistency.
- Replaced POM customization with a direct project description assignment for clarity. - Ensured the description is now used in the generated POM for Maven Central.
…with corresponding tests - Implemented `MarkdownExporter` for generating Markdown documentation from resource docs. - Developed `OBPLikeJsonExporter` to produce JSON documents mirroring OBP-API's ResourceDoc response structure. - Created `OpenApiLikeJsonExporter` for generating OpenAPI-like JSON documents. - Added unit tests for each exporter to ensure correct functionality and output formatting.
- Introduced `OBPResourceDocJson` for generating Draft-04 JSON Schema from case classes. - Updated `ResourceDocJson` to utilize Circe JSON types for request and response bodies. - Added unit tests in `OBPResourceDocJsonSpec` to validate schema generation for sample case classes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.