Automated generation of documentation given an OpenaAPI spec file - Githubissues

dikhan / terraform-provider-openapi

OpenAPI Terraform Provider that configures itself at runtime with the resources exposed by the service provider (defined in a swagger file)

Apache License 2.0

275 stars 48 forks source link

Automated generation of documentation given an OpenaAPI spec file #245

Closed lillchan closed 4 years ago

lillchan commented 4 years ago

Is your feature request related to a problem?

As a Terraform provider using the OpenAPI Terraform plugin
I want to be able to automatically generate my Terraform documentation given my OpenAPI spec
So that I don't have to remember to make manual updates to the documentation when my API changes

Acceptance criteria

What's required to consider this feature request complete?

Example:

Scenario:
Given a Terraform provider OpenAPI spec
When I run the documentation generator
Then the output should contain Terraform documentation

Checklist (for admin only)

Don't forget to go through the checklist to make sure the issue is created properly:

[x] I have added a corresponding label (feature request) to the issue (right side menu)
[x] I have added this issue to the 'API Terraform Provider' GitHub project (right side menu)