chore: PoC - Model generation - Supporting nested schema (objects - Map, MapNested, SingleNested Attributes) #2704
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,7 +46,10 @@ func (s *APISpecSchema) buildResourceAttr(name string, computability ComputedOpt | |
| case OASTypeArray: | ||
| return s.buildArrayAttr(name, computability) | ||
| case OASTypeObject: | ||
| if s.Schema.AdditionalProperties != nil && s.Schema.AdditionalProperties.IsA() { | ||
|
There was a problem hiding this comment. q: what does There was a problem hiding this comment. libopenapi stores additionalProperties as Dynamic values ( |
||
| return s.buildMapAttr(name, computability) | ||
| } | ||
| return s.buildSingleNestedAttr(name, computability) | ||
| default: | ||
| return nil, fmt.Errorf("invalid schema type '%s'", s.Type) | ||
| } | ||
|
|
@@ -210,3 +213,60 @@ func (s *APISpecSchema) buildArrayAttr(name string, computability ComputedOption | |
|
|
||
| return result, nil | ||
| } | ||
|
|
||
| func (s *APISpecSchema) buildMapAttr(name string, computability ComputedOptionalRequired) (*Attribute, error) { | ||
| mapSchema, err := BuildSchema(s.Schema.AdditionalProperties.A) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| result := &Attribute{ | ||
| Name: terraformAttrName(name), | ||
| ComputedOptionalRequired: computability, | ||
| DeprecationMessage: s.GetDeprecationMessage(), | ||
| Description: s.GetDescription(), | ||
| } | ||
|
|
||
| if mapSchema.Type == OASTypeObject { | ||
| mapAttributes, err := buildResourceAttrs(mapSchema) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| result.MapNested = &MapNestedAttribute{ | ||
| NestedObject: NestedAttributeObject{ | ||
| Attributes: mapAttributes, | ||
| }, | ||
| } | ||
| } else { | ||
| elemType, err := mapSchema.buildElementType() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| result.Map = &MapAttribute{ | ||
| ElementType: elemType, | ||
| } | ||
| } | ||
|
|
||
| return result, nil | ||
| } | ||
|
|
||
| func (s *APISpecSchema) buildSingleNestedAttr(name string, computability ComputedOptionalRequired) (*Attribute, error) { | ||
| objectAttributes, err := buildResourceAttrs(s) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &Attribute{ | ||
| Name: terraformAttrName(name), | ||
| ComputedOptionalRequired: computability, | ||
| DeprecationMessage: s.GetDeprecationMessage(), | ||
| Description: s.GetDescription(), | ||
| SingleNested: &SingleNestedAttribute{ | ||
| NestedObject: NestedAttributeObject{ | ||
| Attributes: objectAttributes, | ||
| }, | ||
| }, | ||
| }, nil | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -328,20 +328,19 @@ components: | |
| minLength: 24 | ||
| pattern: ^([a-f0-9]{24})$ | ||
| readOnly: true | ||
| nestedListArrayAttr: | ||
| type: array | ||
| description: Test field description | ||
| items: | ||
| $ref: "#/components/schemas/NestedObjectAttr" | ||
| readOnly: true | ||
| nestedSetArrayAttr: | ||
| type: array | ||
| description: Test field description | ||
| items: | ||
| $ref: "#/components/schemas/NestedObjectAttr" | ||
| readOnly: true | ||
| uniqueItems: true | ||
| setPrimitiveStringAttr: | ||
| type: array | ||
| description: Test field description | ||
|
|
@@ -353,16 +352,45 @@ components: | |
| description: Test field description | ||
| items: | ||
| type: string | ||
| singleNestedAttrWithNestedMaps: | ||
| $ref: "#/components/schemas/SingleNestedAttrWithNestedMaps" | ||
| singleNestedAttr: | ||
| $ref: "#/components/schemas/SingleNestedAttr" | ||
| nestedMapObjectAttr: | ||
| $ref: "#/components/schemas/NestedMapObjectAttr" | ||
| SingleNestedAttrWithNestedMaps: | ||
| type: object | ||
| description: Test field description | ||
| properties: | ||
| mapAttr1: | ||
| type: object | ||
| additionalProperties: | ||
| type: string | ||
| readOnly: true | ||
| readOnly: true | ||
| mapAttr2: | ||
| type: object | ||
| additionalProperties: | ||
| type: string | ||
| readOnly: true | ||
| readOnly: true | ||
| readOnly: true | ||
| title: Outbound Control Plane IP Addresses By Cloud Provider | ||
| SingleNestedAttr: | ||
| type: object | ||
| description: Test field description | ||
| properties: | ||
| innerIntAttr: | ||
| type: integer | ||
| description: Test field description | ||
| innerStrAttr: | ||
| $ref: "#/components/schemas/SimpleStringRefObject" | ||
| required: | ||
| - innerIntAttr | ||
| - innerStrAttr | ||
| NestedObjectAttr: | ||
| type: object | ||
| properties: | ||
| innerNumAttr: | ||
| type: integer | ||
| format: int32 | ||
|
|
@@ -376,20 +404,30 @@ components: | |
| items: | ||
| type: string | ||
| required: | ||
| - innerNumAttr | ||
| NestedTestResourceRequest: | ||
| type: object | ||
| properties: | ||
| nestedListArrayAttr: | ||
| type: array | ||
| description: Test field description | ||
| items: | ||
| $ref: "#/components/schemas/NestedObjectAttr" | ||
| maxItems: 1 | ||
| minItems: 1 | ||
| required: | ||
| - nestedListArrayAttr | ||
| SimpleStringRefObject: | ||
| type: string | ||
| description: Test field description | ||
| NoBody: | ||
| type: object | ||
| description: Endpoint does not return a response body. | ||
| NestedMapObjectAttr: | ||
| type: object | ||
| additionalProperties: | ||
|
There was a problem hiding this comment. q: curious if in our api spec there is use of There was a problem hiding this comment. There is. Connection strings is one example https://github.com/mongodb/atlas-sdk-go/blob/main/openapi/atlas-api-transformed.yaml#L22082 |
||
| type: object | ||
| properties: | ||
| attr: | ||
| type: string | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cleaning up some attrs so the test focuses on nested attrs only