Skip to content

Document the format of types in client.go #11

@displague

Description

@displague

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions