-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Release web microsoft.web 2022 09 01 #22084
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
Conversation
…o version 2022-09-01
* add certs/domains new version folders and readme required changes * add resource IDs to various example files * add more missing IDs
* Add default action property * Identifier Id
* Added built-in workflow operation * Spelling Fixes * Prettier * Added response to example * Lint diff * Better documented DeployWorkflowArtifacts, fixed casing * Updated workflow definition * Correctly defined properties * Fixed properties object * PR Feedback * Prettier and modelvalidation fixes * ModelValidation * SemanticValidation * Spelling * Updated long running operations * Updated workflowArtifacts body * Modelvalidation updated api-version * Fixing sample errors * More model validation updates * Codegen parameters for slots * Updating examples * revert x-ms-longrunning * Updating WorkflowArtifacts * Fixing filestodelete * Replaced exact slot objects with references * added x-ms-parameter-location
* 1. Add more examples 2. Change workflow trigger run and histories to sync operations * Fix WebApp examples * Add metadata property to SiteConfig * Add examples for Slot CRUD and clone web app * Add more examples * Revert changes to workflows/histories/resubmit * Prettier changes * Fix examples. * Revert breaking changes * Add LRO response header to examples
Hi, @naveedaz Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Thank you for your contribution naveedaz! We will review the pull request and get back to you soon. |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
AppServiceCertificateOrders.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
CertificateOrdersDiagnostics.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
CertificateRegistrationProvider.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
DomainRegistrationProvider.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
Domains.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
TopLevelDomains.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
AppServiceEnvironments.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
AppServicePlans.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
Certificates.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
CommonDefinitions.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
ContainerApps.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
ContainerAppsRevisions.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
DeletedWebApps.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
Diagnostics.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
Global.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
KubeEnvironments.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
Provider.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
Recommendations.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
ResourceHealthMetadata.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
ResourceProvider.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
StaticSites.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
WebApps.json | 2022-09-01(92d4e5b) | 2022-03-01(main) |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄
LintDiff inProgress [Detail]
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
about 44 of ModelValidation is from PR #21015 (comment) other appears to be api-version in example is 2021-03-01 |
Hi @naveedaz, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @naveedaz, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
* update Site schema with container app enviornment * add custom words * update managedEnvironment descriptions * update to use managedEnvironmentId
* Update Swagger for Static Web Apps database connections * Remove additional newline and comma * Fix up operationId for put / patch on build database connection * Update api-version in examples * Run prettier * Add 200 status for delete operations * Use StaticSiteDatabaseConnectionOverviewARMResource instead of StaticSiteDatabaseConnectionOverview * Remove StaticSite from operationId in suffix * Fix StaticSiteDatabaseConnectionConfigurationFileOverview definition * Add pattern for environmentName and databaseConnectionName, and remove ProxyOnlyResource from StaticSiteDatabaseConnectionPatchRequestPropertiesARMResource * Add missing pattern and also add x-ms-identifiers for configurationFiles * Update description for connectionIdentity * Simplify request and response entity names * Use shared parameter and reference for environmentName and databaseConnectionName * Update x-ms-identifiers per comments * Add x-ms-secret, combine request and response objects to one with proper readonly annotations * Run prettier * Add required parameters and update ConnectionString -> connection string * Fix required properties for DatabaseConnection * Remove 'name' from DatabaseConnection and update static site object with DatabaseConnectionOverview * Add x-ms-identifiers * Remove connectionString as a required property
* Update Swagger for Static Web Apps basic auth * small fixes * _ * added secret flag * changed api paths away from CRUD operations * changed api to use singleton pattern * small changes
* Updated verbs and routes for workflowsConnections * Updated path, description, and operation ID
* Add definition for ElasticWebAppScaleLimit * Update CommonDefinitions.json Use camel casing for property name --------- Co-authored-by: Naveed Aziz <[email protected]>
@raosuhas web/specifications have multiple RPs in the same client. We would love to move them apart but that is a big breaking change. Unfortunately, openAPIHub does not support creating a branch with multiple RPs as base. This has been our feature request to the openAPI team (@akning-ms , @josefree ) |
All PR (with change to API path) merging into this feature branch has been approved by ARM reviewer |
@MaryGao Please check JS SDK breaking changes |
@msyyc on python failure. |
We will fix the failure soon and please ignore it temporarily. |
Sure. I will probably ask Arthur to force merge this tomorrow. |
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.