Skip to content

Conversation

mikeharder
Copy link
Member

  • Script should not be used for TypeSpec or Folder Structure v2

Copy link

github-actions bot commented Sep 29, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The required check named Protected Files has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide


Comment generated by summarize-checks workflow run.

@mikeharder mikeharder requested a review from heaths September 29, 2025 18:28
@mikeharder mikeharder self-assigned this Sep 29, 2025
@mikeharder mikeharder moved this from 🤔 Triage to 🔬 Dev in PR in Azure SDK EngSys 🍔🌭 Sep 29, 2025
@weshaggard
Copy link
Member

I know this script is mentioned in some of our docs https://eng.ms/docs/products/azure-developer-experience/design/api-specs-pr/api-tutorial/api-tutorial-2-update?tabs=create-openapi so we might want to work with @maririos's team to update those before removing.

@mikeharder
Copy link
Member Author

mikeharder commented Sep 30, 2025

I know this script is mentioned in some of our docs https://eng.ms/docs/products/azure-developer-experience/design/api-specs-pr/api-tutorial/api-tutorial-2-update?tabs=create-openapi so we might want to work with @maririos's team to update those before removing.

@maririos: Are you OK with us removing this script from the repo, and removing references to it, from our docs as well? If this script is no longer relevant to TypeSpec or folder structure v2 (as mentioned by @heaths in chat), does this mean the doc referencing this script, is no longer relevant either?

Probably unrelated, but I noticed this doc also mentions release-* branches. These are becoming a large maintenance burden for a small number of users, and I'm trying to start discussions with stakeholders, about changing the process or delegating the maintenance more fully to each release branch owner.

@qiaozha
Copy link
Member

qiaozha commented Sep 30, 2025

I have some questions.

  1. how do customers today update the examples folder? Do they need to copy that version example and update those apiVersion in the new examples/version folder manually?
  2. Today, not every service has been migrated to TypeSpec, what should those services do to add a new version after migrating to folder structure v2?

@mikeharder
Copy link
Member Author

@maririos: Regardless of future direction, I'd still like to delete this script from the specs repo, if it's no longer being supported or updated. Are you OK with this?

@maririos
Copy link
Member

@maririos: Regardless of future direction, I'd still like to delete this script from the specs repo, if it's no longer being supported or updated. Are you OK with this?

Yes. Here is the PR for updated documentation removing the mention of this script and adding the specific instructions for service teams that are still working on OpenAPI specs.
Could I get a review there to make sure it is accurate?

@maririos
Copy link
Member

I know this script is mentioned in some of our docs https://eng.ms/docs/products/azure-developer-experience/design/api-specs-pr/api-tutorial/api-tutorial-2-update?tabs=create-openapi so we might want to work with @maririos's team to update those before removing.

@maririos: Are you OK with us removing this script from the repo, and removing references to it, from our docs as well? If this script is no longer relevant to TypeSpec or folder structure v2 (as mentioned by @heaths in chat), does this mean the doc referencing this script, is no longer relevant either?

Probably unrelated, but I noticed this doc also mentions release-* branches. These are becoming a large maintenance burden for a small number of users, and I'm trying to start discussions with stakeholders, about changing the process or delegating the maintenance more fully to each release branch owner.

Feel free to create PRs to modify the docs as needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🔬 Dev in PR

Development

Successfully merging this pull request may close these issues.

5 participants