microsoft / microsoft/api-guidelines
Create guidance for additional properties
@markweitzel is already working on this.
Since Jun 14, 2022.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
In Azure, we have additionalProperties that in swagger is just a free-form JSON object. While the free-form object allow greater expression, it also forces customer off a cliff where they have to get the entire JSON response, peel off the additionalProperties object and deserialize it themselves into their own customer-defined structure and/.or do a bunch of runtime casting/type conversions. Maybe we want to consider a guideline on "additional properties" in general (since data-plane has no guideline for this now) and perhaps we want to adopt the map<string, string> approach as this is really easy to expose/model in all programming languages.
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.
Assessment
This issue has not been assessed yet.