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.

Sign up for GitHub

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

Jump to bottom

Document the format of types in client.go #11

Open

displague opened this issue Mar 11, 2022 · 0 comments

Labels

Member

displague commented Mar 11, 2022

client.go provides an interface and types that are consumed by the Terraform provider.

This format does not usually match the internal API structures (which are found in internal/api).

Often, the structures in client.go are a composite type merging the request and response fields.

We should document this intention and provide examples in the README.md so that it is clear to developers and reviewers what expectations we have.

displague added the documentation label

displague mentioned this issue

NFV-18043: modify cluster fields and add mgmt acl in existing device API #9

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment