Skip to content
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

added 2024-05-15 preview #28443

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Conversation

Ritvik-Jayaswal
Copy link

@Ritvik-Jayaswal Ritvik-Jayaswal commented Mar 25, 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.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

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

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

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 generated using OpenAPI Hub).
  • 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:
    • edit this with your clarification

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.
  • 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 PR workflow diagram Step 2 (ARM review), 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.

Copy link

openapi-pipeline-app bot commented Mar 25, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR is not ready for ARM review (label: NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of this Next Steps to Merge comment for details.
    Once the blocking problems are addressed, add to the PR a comment with contents /azp run. Automation will re-evaluate this PR and if everything looks good, it will add WaitForARMFeedback label which will put this PR on the ARM review queue.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ This PR is NotReadyForARMReview because it has the BreakingChangeReviewRequired label.
  • ❌ This PR has at least one breaking change (label: BreakingChangeReviewRequired).
    To unblock this PR, follow the process at aka.ms/brch.
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    Automation should then add WaitForARMFeedback label.
    ❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ The required check named Swagger SpellCheck 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 Swagger PrettierCheck 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 Mar 25, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 34 Errors, 22 Warnings failed [Detail]
Compared specs (v0.10.12) new version base version
cosmos-db.json 2024-07-15-preview(be9138f) 2024-05-15(main)
cosmos-db.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
dataTransferService.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
managedCassandra.json 2024-07-15-preview(be9138f) 2024-05-15(main)
managedCassandra.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
mongoCluster.json 2024-07-15-preview(be9138f) 2024-02-15-preview(main)
mongorbac.json 2024-07-15-preview(be9138f) 2024-05-15(main)
mongorbac.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
notebook.json 2024-07-15-preview(be9138f) 2024-05-15(main)
notebook.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
privateEndpointConnection.json 2024-07-15-preview(be9138f) 2024-05-15(main)
privateEndpointConnection.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
privateLinkResources.json 2024-07-15-preview(be9138f) 2024-05-15(main)
privateLinkResources.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
rbac.json 2024-07-15-preview(be9138f) 2024-05-15(main)
rbac.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
restorable.json 2024-07-15-preview(be9138f) 2024-05-15(main)
restorable.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
services.json 2024-07-15-preview(be9138f) 2024-05-15(main)
services.json 2024-07-15-preview(be9138f) 2024-05-15-preview(main)
throughputpool.json 2024-07-15-preview(be9138f) 2024-05-15-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
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'DataTransferServiceResourceCreateUpdateProperties' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SqlDedicatedGatewayServiceResourceCreateUpdateProperties' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SqlDedicatedGatewayType' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'GraphAPIComputeServiceResourceCreateUpdateProperties' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'MaterializedViewsBuilderServiceResourceCreateUpdateProperties' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3
1019 - RemovedEnumValue The new version is removing enum value(s) '5.0, 6.0' from the old version.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/cosmos-db.json#L11563:9
Old: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L9617:9
1022 - RemovedAdditionalProperties The new version removes the 'additionalProperties' element.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1617:9
Old: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L1227: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/v1/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/v1/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/v1/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/v1/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/v1/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L49:9
Old: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L49:9
1023 - TypeFormatChanged The new version has a different format '' than the previous one 'arm-id'.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1356:13
Old: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L962:13
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L85:9
Old: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L85:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L121:9
Old: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L121:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L159:9
Old: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L159: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
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CapacityMode' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/cosmos-db.json#L7255:3
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L7255:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'DataTransferServiceResourceCreateUpdateProperties' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/services.json#L274:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SqlDedicatedGatewayServiceResourceCreateUpdateProperties' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/services.json#L274:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SqlDedicatedGatewayType' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/services.json#L274:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'GraphAPIComputeServiceResourceCreateUpdateProperties' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/services.json#L274:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'MaterializedViewsBuilderServiceResourceCreateUpdateProperties' removed or renamed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L274:3
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/services.json#L274:3
⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '5.0, 6.0' from the old version.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/cosmos-db.json#L11563:9
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L11661:9
⚠️ 1023 - TypeFormatChanged The new version has a different format '' than the previous one 'arm-id'.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1356:13
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/managedCassandra.json#L1273:13
⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L321:7
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/services.json#L321:7
⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/privateEndpointConnection.json#L157:13
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/privateEndpointConnection.json#L157:13
⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/privateEndpointConnection.json#L201:13
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/privateEndpointConnection.json#L201:13
⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/cosmos-db.json#L7467:5
Old: common-types/resource-management/v5/types.json#L302:5
⚠️ 1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L312:9
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/services.json#L312:9
⚠️ 1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
New: Microsoft.DocumentDB/preview/2024-07-15-preview/services.json#L318:5
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/services.json#L317:5
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'capacityMode' renamed or removed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/cosmos-db.json#L8379:7
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L8379:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'capacityModeChangeTransitionState' renamed or removed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/cosmos-db.json#L8379:7
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L8379:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'capacityMode' renamed or removed?
New: Microsoft.DocumentDB/preview/2024-07-15-preview/cosmos-db.json#L8826:7
Old: Microsoft.DocumentDB/preview/2024-05-15-preview/cosmos-db.json#L8841:7
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️❌Avocado: 219 Errors, 1 Warnings failed [Detail]

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

Rule Message
NO_JSON_FILE_FOUND The JSON file is not found but it is referenced from the readme file.
readme: specification/cosmos-db/resource-manager/readme.md
json: Microsoft.DocumentDB/preview/2024-05-15-preview/mongoCluster.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: preview/2024-05-15-preview/examples/NetworkSecurityPerimeterConfigurationGet.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: preview/2024-05-15-preview/examples/NetworkSecurityPerimeterConfigurationList.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: preview/2024-05-15-preview/examples/NetworkSecurityPerimeterConfigurationReconcile.json
UNREFERENCED_JSON_FILE The swagger JSON file is not referenced from the readme file.
readme: specification/cosmos-db/resource-manager/readme.md
json: Microsoft.DocumentDB/preview/2024-05-15-preview/networkSecurityPerimeter.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraCommandResultList.json
UNREFERENCED_JSON_FILE The swagger JSON file is not referenced from the readme file.
readme: specification/cosmos-db/resource-manager/readme.md
json: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraKeyspaceCreateUpdate.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraKeyspaceDelete.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraKeyspaceGet.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraKeyspaceList.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraKeyspaceThroughputGet.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraTableCreateUpdate.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/cosmos-db/resource-manager/readme.md
json: stable/2024-05-15/examples/CosmosDBCassandraTableDelete.json
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 14 Errors, 0 Warnings failed [Detail]
Rule Message
INVALID_REQUEST_PARAMETER api-version 2023-05-15-preview is not equal to swagger version
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L575:15
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraRestore.json#L2:17
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: api-version
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L657:28
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraRestore.json#L5:20
MAX_LENGTH String is too long (19 chars), maximum 15
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1053:28
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraRestore.json#L7:17
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: value
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1820:38
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraRestore.json#L12:18
INVALID_REQUEST_PARAMETER api-version 2023-05-15-preview is not equal to swagger version
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L615:14
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraGetRestore.json#L2:17
MAX_LENGTH String is too long (19 chars), maximum 15
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1053:28
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraGetRestore.json#L7:17
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: value
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1820:38
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraGetRestore.json#L12:18
INVALID_REQUEST_PARAMETER api-version 2023-05-15-preview is not equal to swagger version
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L575:15
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraRestore.json#L2:17
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: api-version
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L657:28
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraRestore.json#L5:20
MAX_LENGTH String is too long (19 chars), maximum 15
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1053:28
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraRestore.json#L7:17
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: value
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1820:38
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraRestore.json#L12:18
INVALID_REQUEST_PARAMETER api-version 2023-05-15-preview is not equal to swagger version
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L615:14
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraGetRestore.json#L2:17
MAX_LENGTH String is too long (19 chars), maximum 15
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1053:28
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraGetRestore.json#L7:17
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: value
Url: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1820:38
ExampleUrl: preview/2024-07-15-preview/examples/CosmosDBManagedCassandraGetRestore.json#L12:18
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌SpellCheck: 1 Errors, 0 Warnings failed [Detail]
Rule Message
HowToFix Unknown word (Restore's), please fix the error. See https://aka.ms/ci-fix#spell-check
path: Microsoft.DocumentDB/preview/2024-07-15-preview/managedCassandra.json#L1869:27
️️✔️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?

Copy link

openapi-pipeline-app bot commented Mar 25, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️⚠️ azure-sdk-for-python warning [Detail]
    For more instructions, please refer to the FAQ .
  • ⚠️Warning in generating from 1fc78c693120896b48af9cda8162e6b36962c517. 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-cosmosdb [Preview SDK Changes]
️❌ azure-sdk-for-net-track2 failed [Detail]
    For more instructions, please refer to the FAQ .
  • Pipeline Framework Failed in generating from 1fc78c693120896b48af9cda8162e6b36962c517. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to build project. exit code: False
    error	FatalError: ConfigError: Invalid GenerateOutput: .packages[0].installInstructions should be object. Please refer to the schema definitions at https://github.com/Azure/azure-rest-api-specs/tree/main/documentation/sdkautomation to fix the configuration issue.. Please refer to the inner logs for details or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    ConfigError: Invalid GenerateOutput: .packages[0].installInstructions should be object. Please refer to the schema definitions at https://github.com/Azure/azure-rest-api-specs/tree/main/documentation/sdkautomation to fix the configuration issue.
    error	ErrorStack: Error: ConfigError: Invalid GenerateOutput: .packages[0].installInstructions should be object. Please refer to the schema definitions at https://github.com/Azure/azure-rest-api-specs/tree/main/documentation/sdkautomation to fix the configuration issue.    at /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/types/validator.js:32:19    at workflowCallGenerateScript (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:605:69)    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)    at async workflowHandleReadmeMdOrTypeSpecProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:239:40)    at async workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:107:9)    at async sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:217:13)    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18.
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from 1fc78c693120896b48af9cda8162e6b36962c517. 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-cosmos-generated [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from 1fc78c693120896b48af9cda8162e6b36962c517. 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/cosmos/armcosmos [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from 1fc78c693120896b48af9cda8162e6b36962c517. 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-cosmosdb [Preview SDK Changes]
️❌ azure-resource-manager-schemas failed [Detail]
    For more instructions, please refer to the FAQ .
  • Code Generator Failed in generating from 1fc78c693120896b48af9cda8162e6b36962c517. 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.
️⚠️ azure-powershell warning [Detail]
    For more instructions, please refer to the FAQ .
  • ⚠️Warning in generating from 1fc78c693120896b48af9cda8162e6b36962c517. 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
  • ⚠️Az.cosmos-db.DefaultTag [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

@microsoft-github-policy-service microsoft-github-policy-service bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Mar 25, 2024
Copy link
Contributor

Thank you for your contribution Ritvik-Jayaswal! We will review the pull request and get back to you soon.

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version resource-manager labels Mar 25, 2024
Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

Copy link

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]
️🔄 azure-sdk-for-python inProgress [Detail]
️🔄 azure-sdk-for-net-track2 inProgress [Detail]
️🔄 azure-sdk-for-java inProgress [Detail]
️🔄 azure-sdk-for-go inProgress [Detail]
️⌛ azure-sdk-for-js pending [Detail]
️🔄 azure-resource-manager-schemas inProgress [Detail]
️🔄 azure-powershell inProgress [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@pjohari-ms pjohari-ms added the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label Apr 23, 2024
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

@ramoka178
Copy link
Contributor

  1. Please update added 2024-05-15 preview #28443 (comment)
  2. Please fix the required checks failures
  3. Please refer to added 2024-05-15 preview #28443 (comment) for next steps.

@ramoka178 ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jun 27, 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 27, 2024
Copy link
Member

@pjohari-ms pjohari-ms left a comment

Choose a reason for hiding this comment

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

Please do not merge this PR. Let me start an internal chat with Ritvik

@pjohari-ms pjohari-ms added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required customer-reported Issues that are reported by GitHub users external to the Azure organization. DoNotMerge <valid label in PR review process> use to hold merge after approval new-api-version NotReadyForARMReview NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants