[FCFIELDS-44] - PUT /custom-fields does not handle multiple entity types #41
Conversation
…Service replaceAll method
all custom fields in PUT /custom-fields requests should contain the same entityType
PUT on /custom-fields expects a PutCustomFieldCollection
|
Kudos, SonarCloud Quality Gate passed! |
| "metadata": { | ||
| "description": "User metadata information", | ||
| "$ref": "raml-util/schemas/metadata.schema", | ||
| "readonly": true | ||
| } | ||
| }, | ||
| "required": [ | ||
| "customFields" | ||
| "customFields", | ||
| "entityType" |
There was a problem hiding this comment.
This is a breaking change. If any other module uses this API and is not providing entity type will be a problem. Please check impacted modules due to this change.
There was a problem hiding this comment.
Indeed, I've detailed this in the description. The application and interface versions have been bumped to signify this change. No module should be affected by this modification unless it explicitly updates its folio-custom-fields dependency.
However, mod-users will require such an update once the related frontend work is merged. This is tracked over in STSMACOM PR#1417.
| "metadata": { | ||
| "description": "User metadata information", | ||
| "$ref": "raml-util/schemas/metadata.schema", | ||
| "readonly": true | ||
| } | ||
| }, | ||
| "required": [ | ||
| "customFields" | ||
| "customFields", | ||
| "entityType" |
|
@folio-org/volaris-backend Any chance I can get another review on this so things can move forward? |
Purpose
This PR resolves the issue FCFIELDS-44 where the
PUT /custom-fieldsendpoint was unable to handle differententityTypes.Approach
To address this issue, a required attribute called
entityTypehas been added to thePutCustomFieldCollectionschema. This change mandates clients to include theentityTypewhen updating custom fields using the PUT /custom-fields endpoint. With this addition, the implementation can now update custom fields specifically for a certainentityTypewithout affecting others.TODOs and Open Questions
Additional Actions
This is a breaking change. Client implementations will require adjustments to include the
entityTypewhen makingPUTrequests to/custom-fields.