Skip to content

Conversation

@Juliehzl
Copy link
Contributor

@Juliehzl Juliehzl commented Jun 4, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • adding date-time format for OperationStatus start and end times

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

jijohn14 and others added 25 commits June 4, 2024 11:13
* Functions extension api-spec commit

* merge with latest

* Functions Extension in 2024-02-02-preview

* correcetd version in readme

* avacado fail fix - version

* pattern addition

* fix for PathForResourceAction

* lint diff and model validation checks

* AutoRest exception fix

* endpoint response as string and not schema

* response schema with string

* example schema

* example within spec

* extension example with data

* extensions example with body

* body as string
* Add Nacos For Java Component.

* fix spell check.
* [Container Apps] Update Runtime to add DotNet support

* Remove default value

* Rename dotNet to dotnet
…ent (Azure#28005)

* [Container Apps] Remove AspireResourceServerApi type for DotNetComponent

* Only keep changes to 2024-02-02-preview
…ba and eureka (Azure#28102)

* Make the JavaComponent definitions polymorphism

* fix api version

* revert error response change

* refine examples

* fix default value

* fix

* fix

* try to remove required

* try remove require in patch body

* fix

* try fix lint

* fix

* add suppression for discriminator

* fix

---------

Co-authored-by: Xuyang Cao <[email protected]>
* Added CloudBuild and CloudPatch

* Fixed pipeline errors

* Added ContainerApp example

* Fixed typo in example

* Fixed linting error

* Fixed spacing

* Addressed comments

* Addressed comments and modified sample

* Fixed linting error

* Addressed comments

* Linting

* Fixed typo

* Fixed Typo

* Resolving model validation error
* add java agent related properties

* fix build error

* fix format

* re-run pipeline

* update enum list and fix typo

* revert cspell config

* update level field type from enum to string

* add identifiers for array prop
* Adding identity for scale rules

* fix scale example
…28405)

* Added support for KIND property to container apps schema

* added reference to example request schema

* prettier check

* changes to example conforming to swagger

* used enum for app kind

* minor fixes

* merged main

* Revert "merged main"

This reverts commit 2437d60.

* fixed checks
* Add detailed job execution to api

* Add fields

* address comment

* add x-ms-identifiers

* prettier

* address comments

* Address comments

* Address comments

* update example

* Fix property name

* Fix example
* optimize java agent related props

* fix

* adding logging property to include logger settings

---------

Co-authored-by: Bowen Wan <[email protected]>
* add accountName for queueScaler

* updated example

* updated

* updated

* updated
* Adding identity settings

* fix casing in examples

* Switch to array since ARM doesn't allow dictionaries.

* identity property should be required.

* prettier

* Updating description

* Adding Jobs spec

* Update specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Jobs.json

Co-authored-by: Jitin John <[email protected]>

* Move IdentitySettings to CommonDefinitions

---------

Co-authored-by: Jitin John <[email protected]>
* Add SessionPools.json and Sessions.json
* add pe

* fix

* fix

* fix

* fix

* fix

* fix

* use v5

* fix

* fix
* Add support for SMB storage in connectedEnvironment

* move smb properties to common

* fix reference

---------

Co-authored-by: [email protected] <[email protected]>
* API spec for LogicApps extension on Microsoft.App

* format

* fix typos

* fix issues

* fix example references

* fix more issues

* fix issues

* fix more model validation

* fix

* fix model

* fix format

* fix lintdiff

* fix example

* fix headers

* add delete

* add missing file

---------

Co-authored-by: Anand G Menon <[email protected]>
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 4, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 4, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 46 Errors, 62 Warnings failed [Detail]
Compared specs (v0.10.9) new version base version
AppResiliency.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
AuthConfigs.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
AuthConfigs.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
AvailableWorkloadProfiles.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
AvailableWorkloadProfiles.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
BillingMeters.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
BillingMeters.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
Builders.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
Builds.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
CommonDefinitions.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
CommonDefinitions.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ConnectedEnvironments.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
ConnectedEnvironments.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ConnectedEnvironmentsCertificates.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
ConnectedEnvironmentsCertificates.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ConnectedEnvironmentsDaprComponents.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
ConnectedEnvironmentsDaprComponents.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ConnectedEnvironmentsStorages.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
ConnectedEnvironmentsStorages.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ContainerApps.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
ContainerApps.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ContainerAppsRevisions.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
ContainerAppsRevisions.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
Diagnostics.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
Diagnostics.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
DotNetComponents.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
Global.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
Global.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
JavaComponents.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
Jobs.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
Jobs.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ManagedEnvironments.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
ManagedEnvironments.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ManagedEnvironmentsDaprComponentResiliencyPolicies.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ManagedEnvironmentsDaprComponents.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
ManagedEnvironmentsDaprComponents.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ManagedEnvironmentsDaprSubscriptions.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
ManagedEnvironmentsStorages.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
ManagedEnvironmentsStorages.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
SourceControls.json 2024-02-02-preview(f4e6dbc) 2023-05-01(main)
SourceControls.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
Subscriptions.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)
Usages.json 2024-02-02-preview(f4e6dbc) 2023-11-02-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Only 17 items are listed, please refer to log for more details.

Rule Message
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L204:9
Old: common-types/resource-management/v3/types.json#L204:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L210:9
Old: common-types/resource-management/v3/types.json#L209:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9


The following breaking changes are detected by comparison with the latest preview version:

Only 17 items are listed, please refer to log for more details.

Rule Message
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.App/preview/2024-02-02-preview/JavaComponents.json#L401:9
Old: Microsoft.App/preview/2023-11-02-preview/JavaComponents.json#L401:9
⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'AspireResourceServerApi' from the old version.
New: Microsoft.App/preview/2024-02-02-preview/DotNetComponents.json#L405:13
Old: Microsoft.App/preview/2023-11-02-preview/DotNetComponents.json#L405:13
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L204:9
Old: common-types/resource-management/v3/types.json#L204:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L210:9
Old: common-types/resource-management/v3/types.json#L209:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 4 Errors, 59 Warnings failed [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2024-02 package-preview-2024-02(f4e6dbc) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Only 17 items are listed, please refer to log for more details.

Rule Message Related RPC [For API reviewers]
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.App/preview/2024-02-02-preview/Builders.json#L246
RPC-Patch-V1-10
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L1194
RPC-Policy-V1-05, RPC-Put-V1-23
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L1678
RPC-Policy-V1-05, RPC-Put-V1-23
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.App/preview/2024-02-02-preview/ManagedEnvironments.json#L286
RPC-Patch-V1-10
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.App/preview/2024-02-02-preview/AppResiliency.json#L260
RPC-Get-V1-11
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of managedidentity.json.
Location: Microsoft.App/preview/2024-02-02-preview/Builders.json#L377
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of managedidentity.json.
Location: Microsoft.App/preview/2024-02-02-preview/Builders.json#L413
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.App/preview/2024-02-02-preview/Builds.json#L36
RPC-Get-V1-11
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listauthtoken' in:'BuildAuthToken_List'. Consider updating the operationId
Location: Microsoft.App/preview/2024-02-02-preview/Builds.json#L253
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L1214
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L766
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L917
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L921
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L925
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L929
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L933
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L954


The following errors/warnings exist before current PR submission:

Only 17 items are listed, please refer to log for more details.

Rule Message
ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json#L18
ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json#L67
ResourceNameRestriction The resource name parameter 'authConfigName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json#L67
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json#L119
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json#L555
DefinitionsPropertiesNamesCamelCase Property name should be camel case.
Location: Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json#L601
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.App/preview/2024-02-02-preview/BillingMeters.json#L16
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.App/preview/2024-02-02-preview/BillingMeters.json#L37
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L310
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L473
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L522
ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json#L100
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json#L198
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json#L208
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json#L255
ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json#L311
ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsCertificates.json#L18
️❌Avocado: 1 Errors, 1 Warnings failed [Detail]
Rule Message
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/Microsoft.App/connectedEnvironments/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/app/resource-manager/readme.md
json: Microsoft.App/preview/2022-06-01-preview/ConnectedEnvironments.json
⚠️ CIRCULAR_REFERENCE The JSON file has a circular reference.
readme: specification/app/resource-manager/readme.md
json: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 4, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from 9de310ebec28100825e297e7f3296eeef1e71ae6. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    cmderr	[automation_init.sh] npm notice
    cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
    cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
    cmderr	[automation_init.sh] npm notice To update run: npm install -g [email protected]
    cmderr	[automation_init.sh] npm notice
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-mgmt-appcontainers [Preview SDK Changes]
    • azure-mgmt-appcontainers-1.0.0b1.zip
    • azure_mgmt_appcontainers-1.0.0b1-py3-none-any.whl
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 9de310ebec28100825e297e7f3296eeef1e71ae6. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-appcontainers [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-appcontainers-1.0.0-beta.8.jar
    • azure-resourcemanager-appcontainers-1.0.0-beta.8-sources.jar
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 9de310ebec28100825e297e7f3296eeef1e71ae6. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/appcontainers/armappcontainers [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 9de310ebec28100825e297e7f3296eeef1e71ae6. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-appcontainers [Preview SDK Changes]
    • azure-arm-appcontainers-3.0.0-beta.1.tgz
️❌ azure-resource-manager-schemas failed [Detail]
  • Code Generator Failed in generating from 9de310ebec28100825e297e7f3296eeef1e71ae6. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az'
    cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'...
    cmderr	[initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types'
    cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'...
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
    cmderr	[initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
    cmderr	[initScript.sh] npm notice To update run: npm install -g [email protected]
    cmderr	[initScript.sh] npm notice
    error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
    warn	Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500
    cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
    cmderr	[generateScript.sh]            ^
    cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
    cmderr	[generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
    cmderr	[generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
    cmderr	[generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
    cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12)
    cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19)
    cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36)
    cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32)
    cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43)
    cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)
    cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12)
    cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1203:32)
    cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:1019:12)
    cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12)
    error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
    warn	Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    error	ConfigError: the 'breakingChangesLabel' configuration is missing or is incorrect from the 'swagger_to_sdk_config.json file. Please correct the value or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    error	ConfigError: the 'breakingChangesLabel' configuration is missing or is incorrect from the 'swagger_to_sdk_config.json file. Please correct the value or report this issue through https://aka.ms/azsdk/support/specreview-channel.
️️✔️ azure-powershell succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 9de310ebec28100825e297e7f3296eeef1e71ae6. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    error	ConfigError: the 'breakingChangesLabel' configuration is missing or is incorrect from the 'swagger_to_sdk_config.json file. Please correct the value or report this issue through https://aka.ms/azsdk/support/specreview-channel.
  • ️✔️Az.app.DefaultTag [Preview SDK Changes]
    • Az.ContainerAppsApi.0.1.0.nupkg
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 4, 2024

@razvanbadea-msft
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@ms-bogdan-rotaru
Copy link
Contributor

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@ms-bogdan-rotaru
Copy link
Contributor

Please check the errors reported by the required checks.

@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 12, 2024
@Juliehzl
Copy link
Contributor Author

Please check the errors reported by the required checks.

@ms-bogdan-rotaru As I mentioned before, I think there are false alarm.
For lint errors of additional properties, our property is key value pair and it is managed by user, so couldn't be validated by the API.
For lint errors of PatchBodyParametersSchema, I do not see we have property "type" required. Why is it reported?

In addition, all commits are reviewed and get arm signed off.

@Juliehzl Juliehzl added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested SuppressionReviewRequired labels Jun 13, 2024
@ms-bogdan-rotaru
Copy link
Contributor

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@ms-bogdan-rotaru
Copy link
Contributor

Please check the errors reported by the required checks.

@ms-bogdan-rotaru As I mentioned before, I think there are false alarm. For lint errors of additional properties, our property is key value pair and it is managed by user, so couldn't be validated by the API. For lint errors of PatchBodyParametersSchema, I do not see we have property "type" required. Why is it reported?

In addition, all commits are reviewed and get arm signed off.

Thanks for your reply.

  • additionalProperties: this is accepted considering the only time its ok to use it is when the properties are pass thru (user defined) and not subject to any validations.
  • PatchBodyParametersSchema: there is an ongoing check issue which will be addressed

@Juliehzl
Copy link
Contributor Author

For Avocado, there reported file is not what I added in this PR. There should be wrong.

image

@Juliehzl
Copy link
Contributor Author

@ms-bogdan-rotaru Thanks for approving the lint issue. For arm review, you can see all related PRs for commits in my PR get arm signed off.

@ms-bogdan-rotaru ms-bogdan-rotaru added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 14, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 14, 2024
@Juliehzl
Copy link
Contributor Author

/pr RequestMerge

@mentat9 mentat9 merged commit 20b4195 into Azure:main Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.