Fix duplicate operation id caused by use of 2 methods GET/POST method from getKeywordById api #7586
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
A get method should not generally support a POST? It caused duplicates duplicate OperationID that would occur (getKeywordById and getKeywordById_1)
fxprunayre
reviewed
Jan 2, 2024
services/src/main/java/org/fao/geonet/api/registries/vocabularies/KeywordsApi.java
Show resolved
Hide resolved
ianwallen
changed the title
ianwallen
force-pushed
the
fix_keywords_api
branch
from
1775f71
to
69d09a2
Compare
ianwallen
changed the title
fxprunayre
reviewed
Jan 4, 2024
| "Use POST method if you want to support larger parameters list" | ||
| ) | ||
| @RequestMapping( | ||
| path = "/keywordById", |
There was a problem hiding this comment.
Better to keep GET unchanged because it is used in all records when XLink mode is enabled in a catalogue (so it will avoid migration in metadata records). And we can change POST (with keywordByIds) and its (probably only) usage in https://github.com/geonetwork/core-geonetwork/blob/main/web-ui/src/main/resources/catalog/components/utility/UtilityService.js#L709-L710. Then it looks good. @josegar74 can you think of any other usages of this ?
There was a problem hiding this comment.
@fxprunayre
Sorry - I had accidently changed the endpoint to /keywordById. I reverted it back to /keyword for both get and post.
fxprunayre
approved these changes
Jan 5, 2024
ianwallen
added a commit
that referenced
this pull request
Jan 5, 2024
… from getKeywordById api (#7586) * Remove POST method from getKeywordById. api [BP] A get method should not generally support a POST? It caused duplicates duplicate OperationID that would occur (getKeywordById and getKeywordById_1) * Re added POST method for keyword and depreciated the GET api. * Use common private getKeyword function for both api calls. * Revert endpoint back to /keyword for GET
Closed
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.
An api should not do GET/POST in the same operation as it seems to cause issues in open api specification document.
It caused duplicates duplicate OperationID that would occur (getKeywordById and getKeywordById_1)
This PR will split 2 OperationID (getKeywordById and getKeywordByIds)
Checklist
mainbranch, backports managed with labelREADME.mdfilespom.xmldependency management. Update build documentation with intended library use and library tutorials or documentation