fix: OpenAPI - object list extraction [DHIS2-17200] #19320
Merged
Conversation
This file contains 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
… based on Java property name
jbee
commented
Nov 28, 2024
| @@ -304,6 +304,8 @@ private Query<?> getUserQuery(UserQueryParams params, List<String> orders, Query | |||
| hql += hlp.whereAnd() + " u.selfRegistered = true "; | |||
| } | |||
|
|
|||
| // TODO(JB) shoundn't UserInvitationStatus.NONE match "u.invitation = false" and null mean no | |||
There was a problem hiding this comment.
FYI: I left this intentionally for another PR
jbee
commented
Nov 28, 2024
| @@ -217,7 +255,12 @@ private UserQueryParams toUserQueryParams(GetUserObjectListParams params) { | |||
| res.setInvitationStatus(params.getInvitationStatus()); | |||
| res.setUserOrgUnits(params.isUserOrgUnits()); | |||
| res.setIncludeOrgUnitChildren(params.isIncludeChildren()); | |||
| res.setOrgUnitBoundary(params.getOrgUnitBoundary()); | |||
| String ou = params.getOu(); | |||
There was a problem hiding this comment.
FYI: moving this code here is in a way a bugfix so that the orgUnitBoundary parameter can be used and is not always overridden by the effect of addOrganisationUnit.
|
vietnguyen
approved these changes
Nov 28, 2024
david-mackessy
approved these changes
Nov 29, 2024
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
The CRUD
getObjectListmethod has 2 major complications for the OpenAPI analysis@EntityTypeType variable parameter objects were not supported before so a simple version was added that only supports this particular case.
The response broke due to too many properties escaping the parameter type analysis as it would pick up a property from the annotated field (which was renamed) and another one from the getter (which lacked the renaming annotation and therefore wasn't ignored). Therefore the de-duplication is now based on the Java property name, not the name the property gets after considering potential renames from an annotation.
I also added OpenAPI descriptions to all special parameters.
Shared Parameter and Inheritance
Previously there was no support for inheritance which worked but would result in each subclass repeating (duplicating) the parameter properties defined in supertypes. With the changes in this PR a shared parameter will use the declaring class simple name as the "namespace" if no explicit name is defined via
@OpenApi.Shared(name="SchemaName").Automatic Testing
Added a few new OpenAPI tests to make sure the added or fixed features keep working
Manual Testing
/api/openapi/openapi.html?scope=entity:Attribute&skipCache=true&source=true&scope=entity:OrganisationUnit#OrganisationUnit.getObjectList, there should be plenty of parameters with description, the return type should be summarized as<object{#,organisationUnits:array[OrganisationUnit]}>/api/openapi/openapi.json?scope=entity:OrganisationUnitif you know OpenAPI speak