RESTWS-975: Implement Resource Schema Introspection Endpoint #649
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.
Description of what I changed
Overview
This PR adds a new schema introspection endpoint to the OpenMRS REST API that allows clients to dynamically discover all available properties for any REST resource. This feature enhances the API's usability and enables more flexible client implementations.
The implementation includes a service layer component that uses Java reflection to determine resource delegate types and their properties, along with a REST controller that exposes this functionality at
/rest/v1/schemaintrospector/{resourceName}
. This feature enables more flexible client implementations by providing comprehensive information about available properties, their types, and inheritance relationships, allowing frontend developers to build dynamic interfaces and select properties for custom representations without having to manually explore the API structure. The code is thoroughly tested with unit tests covering both service and controller components to ensure reliability.The implementation includes three test classes:
SchemaIntrospectionServiceImplTest:
Tests the service-layer functionalitySchemaIntrospectionControllerTest:
Tests the controller with mocked dependenciesSchemaIntrospectionTest:
Tests property discovery on actual OpenMRS domain classesPicture attached is the JSON being successfully obtained for the patient resource.

Issue I worked on
https://openmrs.atlassian.net/browse/RESTWS-975
Checklist: I completed these to help reviewers :)
[
x
] My IDE is configured to follow the code style of this project.No? Unsure? -> configure your IDE, format the code and add the changes with
git add . && git commit --amend
[
x
] I have added tests to cover my changes. (If you refactoredexisting code that was well tested you do not have to add tests)
No? -> write tests and add them to this commit
git add . && git commit --amend
[
x
] I ranmvn clean package
right before creating this pull request andadded all formatting changes to my commit.
No? -> execute above command
[
x
] All new and existing tests passed.No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.
[
x
] My pull request is based on the latest changes of the master branch.No? Unsure? -> execute command
git pull --rebase upstream master