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.

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

Ask for API version when user associates pull request #8631

Open
Tracked by #8983
ladonnaq opened this issue Jul 15, 2024 · 4 comments
Open
Tracked by #8983

Ask for API version when user associates pull request #8631

ladonnaq opened this issue Jul 15, 2024 · 4 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Engagement Experience

Comments

@ladonnaq
Copy link
Member

ladonnaq commented Jul 15, 2024

Requirement: SDK stakeholders have asked for the API Spec version data. There is not a way to programmatically determine and validate the API version. Update the API readiness milestone to ask the user to enter the API version and update the API Spec work item field API Spec version with the input by the user.

Proposed UI changes:

image

Also in the Release Planner app update the UI with:
API details - Add new field named "API version" with the value of the API version as indicated by the user.

image
@praveenkuttappan
Copy link
Member

I have looked at few TypeSpec spec projects and I don't see any easy way to auto detect API version. So for now, I think we can just ask user to provide API-version.

@praveenkuttappan praveenkuttappan moved this from 🤔 Triage to 🐝 Dev in Azure SDK EngSys 🚢🎉 Sep 24, 2024
@praveenkuttappan praveenkuttappan moved this from Backlog to In Progress in Engagement Experience Sep 24, 2024
@praveenkuttappan praveenkuttappan self-assigned this Sep 24, 2024
@ladonnaq
Copy link
Member Author

I have looked at few TypeSpec spec projects and I don't see any easy way to auto detect API version. So for now, I think we can just ask user to provide API-version.

Thanks for investigating! For now user input that is self-attested is better than no data.

We should open an issue and put in backlog. Perhaps we raise requirement to TypeSpec. API version is core metadata.

@praveenkuttappan
Copy link
Member

We may not need any user input for API version based on the discussion about TypeSpec based codegen. Let's revisit this change request and decide the plan accordingly.

@ladonnaq
Copy link
Member Author

We may not need any user input for API version based on the discussion about TypeSpec based codegen. Let's revisit this change request and decide the plan accordingly.

The requirement to map API version to SDK version is also applicable for SDKs generated using OpenAPI. Should we have 2 issues - one for TypeSpec and one for OpenAPI?

@maririos maririos moved this from In Progress to Backlog in Engagement Experience Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. Engagement Experience
Projects
Status: Backlog
Development

No branches or pull requests

3 participants