hashicorp / terraform-plugin-codegen-openapi

OpenAPI to Terraform Provider Code Generation Specification
Mozilla Public License 2.0
49 stars 9 forks source link

Omit Empty Description Strings in Specification #34

Closed bflad closed 1 year ago

bflad commented 1 year ago

Currently, the specification output from the pet store has empty descriptions such as:

    "datasources": [
        {
            "name": "order",
            "schema": {
                "attributes": [
                    {
                        "name": "complete",
                        "bool": {
                            "computed_optional_required": "computed_optional",
                            "description": ""
                        }
                    },
                    {
                        "name": "id",
                        "int64": {
                            "computed_optional_required": "computed_optional",
                            "description": ""
                        }
                    },
                    {
                        "name": "petId",
                        "int64": {
                            "computed_optional_required": "computed_optional",
                            "description": ""
                        }
                    },

The empty string descriptions should not be present as they have no value to the specification or generated code.

github-actions[bot] commented 3 months ago

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