microsoft / microsoft/api-guidelines
@nextLink vs. nextLink
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
Hi,
The guidelines describe that collections should have a @nextLink attribute.
However, in practice some Microsoft services use nextLink (without @).
See https://azure.github.io/projects/apis/#!/DeploymentOperations/DeploymentOperations_List for example.
What is preferred? I can expect the @ can make it harder to work with the model in JavaScript or when (de)serializing in .NET.
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 by comparing the collection naming guidance with the DeploymentOperations_List example linked in the issue. Resolve which form is preferred for API guidelines, then update the relevant guidance to document the decision and its serialization implications.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100