Skip to content
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.

Sign up for GitHub

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

Jump to bottom

support for enum values description #90

Closed
baywet opened this issue Apr 9, 2021 · 4 comments · Fixed by #1557
Closed

support for enum values description #90

baywet opened this issue Apr 9, 2021 · 4 comments · Fixed by #1557
Assignees
@baywet
Labels
enhancement New feature or request fixed generator Issues or improvements relater to generation capabilities.
Milestone
Complete Graph AP...

Comments

@baywet
Copy link
Member

baywet commented Apr 9, 2021 •
edited by azure-boards bot
Loading

Today Kiota doesn't support adding descriptions for enum values. This can be really useful to guide the SDK user.
The spec work to "hold the information" is in progress json-schema-org/json-schema-vocabularies#47
AB#8917
@baywet baywet added the enhancement New feature or request label Apr 9, 2021
@baywet baywet added this to the Beta milestone Apr 9, 2021
@baywet baywet self-assigned this Apr 9, 2021
@darrelmiller darrelmiller modified the milestones: Alpha, Beta Apr 21, 2021
@baywet baywet added the generator Issues or improvements relater to generation capabilities. label Jul 21, 2021
@baywet baywet modified the milestones: Beta, GA Jul 22, 2021
@darrelmiller
Copy link
Member

This will not be available in OpenAPI until OpenAPI 3.1 is supported by OpenAPI.NET

@baywet baywet added the blocked This work can't be done until an external dependent work is done. label Nov 16, 2021
@darrelmiller
Copy link
Member

We should consider if we want to support the x-ms-enum extension that AutoREST uses in the interim. https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-enum

@baywet
Copy link
Member Author

baywet commented Jan 24, 2022

Thanks, created microsoft/OpenAPI.NET.OData#164 for the conversion library as this information is not carried forward to the OpenAPI description for the time being.

@baywet baywet added this to Kiota Feb 18, 2022
@baywet baywet moved this to Todo in Kiota Feb 18, 2022
@baywet
Copy link
Member Author

baywet commented Mar 31, 2022

while we're at it, we should also capture the serialization value as when enums values get escaped, it scraps the serialization today.

@baywet baywet removed the blocked This work can't be done until an external dependent work is done. label Mar 31, 2022
@baywet baywet moved this from Todo to In Progress in Kiota May 5, 2022
@baywet baywet mentioned this issue May 6, 2022
Merged
@baywet baywet added the fixed label May 9, 2022
Repository owner moved this from In Progress to Done in Kiota May 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@baywet baywet

Labels
enhancement New feature or request fixed generator Issues or improvements relater to generation capabilities.
Projects
Kiota
Archived in project
Milestone
Complete Graph API Surface support
Development

Successfully merging a pull request may close this issue.

adds support for enum descriptions microsoft/kiota
2 participants
@darrelmiller @baywet