Add schema overrides to generator config for `description` - Githubissues

hashicorp / terraform-plugin-codegen-openapi

OpenAPI to Terraform Provider Code Generation Specification

Mozilla Public License 2.0

49 stars 9 forks source link

Add schema overrides to generator config for `description` #52

Closed austinvalle closed 1 year ago

austinvalle commented 1 year ago

Closes #49

This PR adds a new overrides section to the existing schema.attributes config options for resources + datasources.

Example

resources:
  pet:
    # create, read, update, delete configuration
    # ...
    schema:
      description: Manages a pet resource
      attributes:
        overrides:
          id:
            description: My more important description of the root identifier attribute
          "nested_obj.id":
            description: My more important description of the nested identifier attribute

Notes

Moved ResourceAttributes, DataSourceAttributes and ProviderAttributes into their own .go files 👍🏻
Still kicking the can down the road for error handling, currently the error strategy prefers ignoring errors + continuing vs. throwing errors for misconfigurations. Perhaps a --strict or the opposite, argument should be considered for controlling how forgiving the error handling is.

github-actions[bot] commented 3 months ago

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.