Enhance plan schemas

[piotrmiskiewicz]

This PR enhance plan schemas by adding titles to enum values.
Related to #651

[msftclas]

All CLA requirements met.

[piotrmiskiewicz]

The cosmos DB (Mongo) provides a schema with 'readRegions':

"readRegions": {
  "type": "array",
  "title": "Read Regions",
  "description": "Read regions to be created, your data will be synchronized across these regions."
                                      },

The items field is missing. It should looks like:

"allowedIPRanges": {
   "type": "array",
   "title": "OneOf IP ranges",
   "description": "Values to include in IP Filter. Can be an IP Address or CIDR range.",
   "items": {
   "type": "string",
   "description": "Must be a valid IP address or CIDR"
    }
 }

I'd like to add missing items, but I don't know what should be added there.

[polskikiel]

You can also use the schemas.EnabledDisabledValues() in the following files:

• pkg/services/rediscache/plan_schemas.go
• pkg/services/storage/plan_schemas.go

[polskikiel]

You can delete AllowedValues field and adjust the description.

[piotrmiskiewicz]

Fixed

[polskikiel]

Please add space to the //nolint comment to align it to the other occurences.

[zhongyi-zhang]

Are the read regions the same set to locations @norshtein?

[norshtein]

No, they are not the same. Allowed values of Cosmos read region can be found here. It is slightly different from location values.

[piotrmiskiewicz]

I've added read locations to the Cosmos DB Mongo schema

[norshtein]

I prefer to keep previous allowedValues for some time. Although it seems to be redundant, it can provide backward compatibility. Could you keep allowedValues unchanged?

[zhongyi-zhang]

I think we don't need to consider backward compatibility in this case. The parsers which leverage React or Angular won't be impacted. On the contrary, with both AllowedValues and OneOf, I am not sure whether they are impacted. And, With the announcement in release note, if the change really breaks some parsers, the user still can wait for the fix in the parser side. Make sense?

[piotrmiskiewicz]

React jsonschema (https://github.com/mozilla-services/react-jsonschema-form) does not work with both. The 'oneOf' field works very nice

[zhongyi-zhang]

Oh, good to know. Then the old should be removed for sure. @piotrmiskiewicz thanks a lot for nice contribution! I’ll merge it as the CI also passed.

[zhongyi-zhang]

LGTM.

[piotrmiskiewicz]

When do you plan to do a new release?

[zhongyi-zhang]

Soon. We are going to release after passing the release pipeline and a quick e2e test :).