microsoft / microsoft/api-guidelines
Why does collection response use `value` property instead of `values` in Azure API guidelines?
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
I am looking at Azure API guidelines - Collections section. https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#collections
YOU SHOULD use
valueas the name of the top-level array field unless a more appropriate name is available.
I am curious to know why a property is using singular word when it represents a collection of entities.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Collections section in azure/Guidelines.md, especially the guidance on naming the top-level array field, and read the issue comments for existing context. Done would mean documenting the rationale for using “value” or clarifying the guideline if its wording needs revision.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100