chore: Improve TF schema attribute name generation #3840
Conversation
manupedrozo
force-pushed
the
CLOUDP-349435-custom-case-conversion
branch
from
4d2dc20 to
5cdcd83
Compare
| method: PATCH | ||
| version_header: application/vnd.atlas.2023-01-01+json | ||
| schema: | ||
| aliases: |
There was a problem hiding this comment.
nice with simplified config!
| path: /api/atlas/v2/groups/{groupId}/auditLog | ||
| version_header: application/vnd.atlas.2023-01-01+json | ||
| name: auditing_api | ||
| packageName: auditingapi |
There was a problem hiding this comment.
[nit] Aren't these always following the same rule. Do we need to be explicit?
There was a problem hiding this comment.
No need to be explicit but would rather calculate once and avoid maintaining consistency in multiple places.
We now set it once during spec generation and reuse it during code generation, which also makes it configurable in the intermediate model.
| groupId: projectId | ||
| group_id: project_id | ||
| nested_list_array_attr.inner_num_attr: inner_num_attr_alias | ||
| outer_object.nested_level1.level_field1: level_field1_alias |
There was a problem hiding this comment.
nit: should we adjust these overrides? Not certain if the snake case is still supported
There was a problem hiding this comment.
These are still supported!
We can provide aliases for TF schema attributes. I expect that we'll do this for group_id -> project_id before releasing an autogen resource.
Description
Improving the generation of TF schema attribute names to provide better default UX.
Implemented a custom snake case conversion that treats multiple consecutive uppercase letters as part of the same word, except for the last one.
Examples:
Before:
MongoDBMajorVersion->mongo_dbmajor_versionAfter:
MongoDBMajorVersion->mongo_db_major_versionBefore:
AwsIAMType->aws_iamtypeAfter:
AwsIAMType->aws_iam_typeRemoved
xstringsusage fromstringcasepackage.Removed
snake_casetocamelCaseconversions across the autogen code.Converting from camelCase to snake_case is fine but its not a reversible operation (see #3740).
Config aliases are no longer case converted (preventing potential inconsistencies).
Example:
To add an alias for the cluster name in path: /api/atlas/v2/groups/{groupId}/clusters/{clusterName}
Before we would provide
cluster_name: name.cluster_namewould be converted toclusterNameand replaced in the path.Now we directly provide
clusterName: name.Link to any related issue(s): CLOUDP-349435
Type of change:
Required Checklist:
Further comments