Skip to content

Create guidance for additional properties #359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markweitzel opened this issue May 21, 2022 · 0 comments
Open

Create guidance for additional properties #359

markweitzel opened this issue May 21, 2022 · 0 comments
Assignees
Labels
Azure Guidelines This issue relates to the Azure Guidelines. enhancement

Comments

@markweitzel
Copy link
Member

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.

@markweitzel markweitzel added enhancement Azure Guidelines This issue relates to the Azure Guidelines. labels May 21, 2022
@markweitzel markweitzel moved this to Backlog in API Stewardship Jun 8, 2022
@markweitzel markweitzel moved this from In Progress to Backlog in API Stewardship Jun 8, 2022
@markweitzel markweitzel self-assigned this Jun 14, 2022
@markweitzel markweitzel moved this from Backlog to In Progress in API Stewardship Jun 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Azure Guidelines This issue relates to the Azure Guidelines. enhancement
Projects
None yet
Development

No branches or pull requests

2 participants