APIv4 - Treat navigation permissions as array, add pseudoconstant for operator #22160
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
|
(Standard links)
|
… operator This gives consistency in how the fields are handled in the Navigation and Dashboard entities
d071483 to
6e9fbc8
Compare
|
@colemanw I agree with this standardisation and I think it is low-risk from a compatibility point of view - but does require documentation in our api change log |
|
Ok @eileenmcnaughton you twisted my arm and I've spent some time cleaning up https://lab.civicrm.org/documentation/docs/dev/-/blob/master/docs/api/v4/changes.md I added disclaimer at the top, to say that only "major or breaking changes" will be listed here and other notes found in the following other places... That makes me feel better about the thing not being too overwhelming, maybe now we (I) can keep up with it. |
|
looks good @colemanw |
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.
Overview
Adds metadata for the sake of consistently handling the
permissionandpermission_operatorfields in APIv4.Before
API treats comma-separated
permissionfield inconsistently: as string forNavigationentity but as array forDashboard.No discoverable options for
permission_operatorin either entity.After
Consistent with other serialized strings, the API treats comma-separated
permissionas an arrayOptions for
permission_operatordiscoverable.Technical Details
Technically, this is a breaking API change for the
Navigationentity. However I highly doubt anyone is using it in the wild. Even our core code uses APIv3 for nav menu items. I found and updated one line in the SearchKit that was passing a string and now needs to pass an array. Afform, etc. didn't need updating because it still uses v3.This change doesn't affect v3, which is fairly indifferent to metadata. So if we're going to do this change I'd rather get it over with now before APIv4 managed entities becomes a thing in this (5.45) release cycle.