Skip to content

[contoso] Move TSP for folder structure v2 #34679

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

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

mikeharder
Copy link
Member

@mikeharder mikeharder commented May 14, 2025

Changelog

  1. Move TSP sources from contosowidgetmanager/Contoso.WidgetManager to contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager.
  2. Move TSP sources from contosowidgetmanager/Contoso.Management to contosowidgetmanager/resource-manager/Microsoft.Contoso.
  3. Copy contosowidgetmanager/Contoso.WidgetManager.Shared/main.tsp to shared.tsp in both data-plane and resource-manager folders.
  4. Update emitter-output-dir in tspconfig.yaml files for new folder depth
  5. Add arm-types-dir in resource-manager/.../tspconfig.yaml for new folder depth

Note: Ignore temp infra changes outside folder specification/contosowidgetmanager

Copy link

openapi-pipeline-app bot commented May 14, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ 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
  • ❌ The required check named spec-gen-sdk - go - pullrequest 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

Copy link

openapi-pipeline-app bot commented May 14, 2025

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

Copy link

github-actions bot commented May 14, 2025

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
Swagger Azure.Contoso.WidgetManager
Swagger Microsoft.Contoso

Copy link
Member

@JeffreyRichter JeffreyRichter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The folder structure should be identical to what you did in https://github.com/Azure/azure-rest-api-specs/pull/34677/files

It's just that the tspconfig.yaml, TS files & examples folders also go in the ServiceName folders

@mikeharder
Copy link
Member Author

The folder structure should be identical to what you did in https://github.com/Azure/azure-rest-api-specs/pull/34677/files

It's just that the tspconfig.yaml, TS files & examples folders also go in the ServiceName folders

I was intentionally splitting the changes to TSP and changes to readme/swagger into separate PRs for analysis. I can create a third PR with both changes merged.

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

Successfully merging this pull request may close these issues.

3 participants