hashicorp / hashicorp/vault-client-go

Naming choices for list vs other operation types

Open
#191 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
133
Forks
23
PR merge metrics
No merged PRs in 30d

Description

# Expected Behavior

I'd expect the same name to be used to describe the same concept, in the names of all API calls manipulating it.

# Current Behavior

Taking the `auth/github` backend as an example:

https://github.com/hashicorp/vault/blob/ece2995ee1df24341ec1dd0fdcc2fdedc6737806/builtin/credential/github/backend.go#L38-L45

Why has the operation for **listing** team configuration items been set to describe team configuration items as "teams", whereas the operations for reading/writing/deleting team configuration items been set to describe team configuration items as "team mappings" ?

I have no strong feelings whether these things are described as "teams" or "team mappings", but I do feel the set of APIs to perform list/read/write/delete operations on them ought to all agree on what they call the single kind of thing.

Contributor guide

Open the contributing guide

Research direction

Start with the referenced builtin/credential/github/backend.go lines and compare the list, read, write, and delete operation names for team configuration items. Check how those operations are represented in the generated OpenAPI client; done means the related API calls use one consistent name.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.