microsoft / microsoft/api-guidelines
Handling canonical dictionaries in resources
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
If an object contains inherent dictionaries (that usually contain custom keys) in its properties, like:
{
id: '1234'
customInfo: { customProperty1: value1, customProperty2: value2}
}
How is it expected to perform filtering and sorting on collections of such objects?
For example:
/collectionName?orderBy=customInfo.customProperty1
Or
/collectionName?filter=customInfo.customProperty1 eq value1
Is this acceptable?
Thank you!
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
No file, test, or entry point is named. Start with the issue's examples of nested custom dictionaries, then determine and document the expected filtering and sorting behavior for those properties in the API guidelines.
Written by the indexing model from the issue text.
Assessment
- Domain
- api
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100