enhace #793: add Odata sanitized property name #873
Conversation
lib/model/query/datasets.js
Outdated
| @@ -268,6 +269,7 @@ const getMetadata = (dataset) => async ({ all, Datasets }) => { | |||
| if (!propertiesMap.has(property.name)) { | |||
| propertiesMap.set(property.name, { | |||
| ...property, | |||
| name: sanitizeFieldsForOdata ? sanitizeOdataIdentifier(property.name) : property.name, | |||
There was a problem hiding this comment.
Because of the update modal, I think Frontend needs to know both the actual property name and the OData identifier. It needs to know the actual property name so that it can make the correct PATCH request from the update modal in the entities table. Rather than overwriting name, what do you think about adding a second property, maybe odataName?
There was a problem hiding this comment.
how about I return name and odataName in all situations and remove odata query parameter?
There was a problem hiding this comment.
That sounds good to me. 👍
docs/api.md
Outdated
| @@ -4608,6 +4609,7 @@ These are in alphabetic order, with the exception that the `Extended` versions o | |||
| + isNew: `true` (boolean, required) - Whether or not this Property is new (will be created by publishing the Draft Form). | |||
|
|
|||
| ## Property Detailed (object) | |||
| + name: `first_name` (string, required) - The name of the Property. | |||
| + name: `the.age` (string, required) - The name of the Property. | |||
| + odataName: `the_age` (string, required) - OData santized name of the property. | |||
There was a problem hiding this comment.
I'm thinking that a little more explanation might be helpful:
The name of the property as it will appear in OData. OData property names can only contain alphanumeric characters and underscores.
sadiqkhoja
changed the title
Closes getodk/central-frontend#793
What has been done to verify that this works as intended?
Integration Test
Why is this the best possible solution? Were any other approaches considered?
NA
How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
No
Does this change require updates to the API documentation? If so, please update docs/api.md as part of this PR.
Yes
Before submitting this PR, please make sure you have:
make test-fulland confirmed all checks still pass OR confirm CircleCI build passes