Skip to content

[TEST] New directory structure format for Contoso Widget Manager #34617

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
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

mario-guerra
Copy link
Contributor

Revised the contoso widget manager spec folder to conform to this structure:

specification/
└── <rpNamespace>/
    ├── cspell.yaml
    └── resource-manager/
        ├── readme.md
        ├── operations/
        └── <ServiceName1>/
            ├── tspconfig.yaml
            ├── main.tsp
            ├── models.tsp
            ├── readme.md
            └── examples/
                └── <api-version>/
            └── preview/
                └── <api-version>/
                    ├── <swagger .json files>
                    └── examples/
            └── stable/ (if applicable)
                └── <api-version>/
                    ├── <swagger .json files>
                    └── examples/
    └── data-plane/
        └── <ServiceName2>/
            ├── tspconfig.yaml
            ├── main.tsp
            ├── models.tsp
            ├── readme.md
            └── examples/
                └── <api-version>/
            └── preview/
                └── <api-version>/
                    ├── <swagger .json files>
                    └── examples/
            └── stable/ (if applicable)
                └── <api-version>/
                    ├── <swagger .json files>
                    └── examples/

Copy link

openapi-pipeline-app bot commented May 12, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The required check named TypeSpec Validation 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 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

Copy link

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

Copy link

github-actions bot commented May 12, 2025

API Change Check

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

Language API Review for Package
Swagger Contoso
Swagger Contoso.WidgetManager
TypeSpec Microsoft.Contoso
TypeSpec Azure.Contoso.WidgetManager
go sdk/contosowidget/azmanager
Go sdk/contosowidget/azmanager
go sdk/resourcemanager/contoso/armcontoso
Go sdk/resourcemanager/contoso/armcontoso
C# Azure.Template.Contoso
C# Azure.ResourceManager.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.

Let's do this right...

The are 2 Contoso services: WidgetManagent (control-plane) and Widget (data-plane)
The RP Namespace is Contoso.Widget

Under data-plane, the folder should be "Widget"
Under resource-manager, the immediate folder is the RP Namespace: "Contoso.Widget"
Under this "Contoso.Widget" folder is the control-plane service name folder: "WidgetManagement"

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

Successfully merging this pull request may close these issues.

4 participants