-
Notifications
You must be signed in to change notification settings - Fork 209
Add support for custom shapes using simplified schema #574
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| // Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"). You may | ||
| // not use this file except in compliance with the License. A copy of the | ||
| // License is located at | ||
| // | ||
| // http://aws.amazon.com/apache2.0/ | ||
| // | ||
| // or in the "license" file accompanying this file. This file is distributed | ||
| // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| // express or implied. See the License for the specific language governing | ||
| // permissions and limitations under the License. | ||
|
|
||
| package sdk | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| awssdkmodel "github.com/aws-controllers-k8s/code-generator/pkg/api" | ||
| ackmodel "github.com/aws-controllers-k8s/code-generator/pkg/model" | ||
| simpleschema "github.com/kro-run/kro/pkg/simpleschema" | ||
| apiextv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1" | ||
rushmash91 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ) | ||
|
|
||
| // InjectSimpleSchemaShapes processes custom shapes from the top-level custom_shapes | ||
| // section and injects them into the SDK API model. | ||
| // Only string types are supported - all other types will cause a panic. | ||
| func (h *Helper) InjectSimpleSchemaShapes(sdkapi *ackmodel.SDKAPI) error { | ||
rushmash91 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if len(h.cfg.CustomShapes) == 0 { | ||
| return nil | ||
| } | ||
|
|
||
| apiShapeNames := sdkapi.API.ShapeNames() | ||
| for shapeName, fieldsMap := range h.cfg.CustomShapes { | ||
| // check dublicates | ||
rushmash91 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| for _, as := range apiShapeNames { | ||
| if as == shapeName { | ||
| return fmt.Errorf("shapeName %s already exists in the API", shapeName) | ||
rushmash91 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
| schemaObj := convertMapValues(fieldsMap) | ||
| openAPISchema, err := simpleschema.ToOpenAPISpec(schemaObj) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Create and register the base structure shape | ||
| shape, shapeRef := h.createBaseShape(sdkapi, shapeName, openAPISchema) | ||
| sdkapi.API.Shapes[shape.ShapeName] = shape | ||
| sdkapi.CustomShapes = append(sdkapi.CustomShapes, &ackmodel.CustomShape{ | ||
| Shape: shape, | ||
| ShapeRef: shapeRef, | ||
| MemberShapeName: nil, | ||
| ValueShapeName: nil, | ||
| }) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // convertFieldsMapToSchemaObj converts a fields map to a schema object for OpenAPI spec generation | ||
| func convertMapValues(fieldsMap map[string]string) map[string]interface{} { | ||
| schemaObj := make(map[string]interface{}) | ||
| for fieldName, fieldType := range fieldsMap { | ||
| schemaObj[fieldName] = fieldType | ||
| } | ||
| return schemaObj | ||
| } | ||
|
|
||
| // createBaseShape creates a base structure shape with its member fields | ||
| func (h *Helper) createBaseShape( | ||
rushmash91 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| sdkapi *ackmodel.SDKAPI, | ||
| shapeName string, | ||
| openAPISchema *apiextv1.JSONSchemaProps, | ||
| ) (*awssdkmodel.Shape, *awssdkmodel.ShapeRef) { | ||
| injector := customShapeInjector{sdkapi} | ||
| shape := &awssdkmodel.Shape{ | ||
| API: sdkapi.API, | ||
| ShapeName: shapeName, | ||
| Type: "structure", | ||
| Documentation: "// Custom ACK type for " + shapeName, | ||
| MemberRefs: make(map[string]*awssdkmodel.ShapeRef), | ||
| } | ||
|
|
||
| properties := openAPISchema.Properties | ||
| for fieldName, propObj := range properties { | ||
| propType := propObj.Type | ||
| if propType != "string" { | ||
| panic(fmt.Sprintf("Field %s in shape %s has non-string type '%s'", | ||
| fieldName, shapeName, propType)) | ||
| } | ||
| addStringFieldToShape(sdkapi, shape, fieldName, shapeName) | ||
| } | ||
|
|
||
| shapeRef := injector.createShapeRefForMember(shape) | ||
| return shape, shapeRef | ||
| } | ||
|
|
||
| // addStringFieldToShape adds a string field to the parent shape | ||
| func addStringFieldToShape( | ||
| sdkapi *ackmodel.SDKAPI, | ||
| parentShape *awssdkmodel.Shape, | ||
| fieldName string, | ||
| shapeName string, | ||
| ) { | ||
| injector := customShapeInjector{sdkapi} | ||
| fieldShape := &awssdkmodel.Shape{ | ||
| API: sdkapi.API, | ||
| ShapeName: fieldName, | ||
| Type: "string", | ||
| } | ||
|
|
||
| sdkapi.API.Shapes[fieldShape.ShapeName] = fieldShape | ||
| parentShape.MemberRefs[fieldName] = injector.createShapeRefForMember(fieldShape) | ||
| } | ||
15 changes: 15 additions & 0 deletions
15
pkg/testdata/models/apis/dynamodb/0000-00-00/generator-with-custom-shapes.yaml
rushmash91 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| custom_shapes: | ||
| RepicasState: | ||
| RegionName: string | ||
| RegionStatus: string | ||
| RegionStatusDescription: string | ||
| RegionStatusPercentProgress: string | ||
| RegionInaccessibleDateTime: string | ||
|
|
||
| resources: | ||
| Table: | ||
| fields: | ||
| ReplicaStates: | ||
| custom_field: | ||
| list_of: RepicasState | ||
| is_read_only: true |
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.
Uh oh!
There was an error while loading. Please reload this page.