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

Swagger Changes to Support Extended Groups for NFSv3 #26712

Closed
wants to merge 34 commits into from

Conversation

cagrawal-msft
Copy link
Contributor

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

Copy link

openapi-pipeline-app bot commented Nov 15, 2023

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ 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.
  • ❌ 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.

Copy link

openapi-pipeline-app bot commented Nov 15, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 77 Errors, 21 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
blob.json 2023-04-01(6970c8d) 2023-01-01(main)
blob.json 2023-04-01(6970c8d) 2020-08-01-preview(main)
common.json 2023-04-01(6970c8d) 2023-01-01(main)
common.json 2023-04-01(6970c8d) 2020-08-01-preview(main)
file.json 2023-04-01(6970c8d) 2023-01-01(main)
file.json 2023-04-01(6970c8d) 2020-08-01-preview(main)
privatelinks.json 2023-04-01(6970c8d) 2023-01-01(main)
privatelinks.json 2023-04-01(6970c8d) 2020-08-01-preview(main)
queue.json 2023-04-01(6970c8d) 2023-01-01(main)
queue.json 2023-04-01(6970c8d) 2020-08-01-preview(main)
table.json 2023-04-01(6970c8d) 2023-01-01(main)
table.json 2023-04-01(6970c8d) 2020-08-01-preview(main)
common.json 2023-10-01(6970c8d) 2023-01-01(main)
common.json 2023-10-01(6970c8d) 2020-08-01-preview(main)
privatelinks.json 2023-10-01(6970c8d) 2023-01-01(main)
privatelinks.json 2023-10-01(6970c8d) 2020-08-01-preview(main)

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

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

Rule Message
1019 - RemovedEnumValue The new version is removing enum value(s) 'PATCH, CONNECT, TRACE' from the old version.
New: Microsoft.Storage/stable/2023-04-01/common.json#L34:11
Old: Microsoft.Storage/stable/2023-01-01/common.json#L34:11
1019 - RemovedEnumValue The new version is removing enum value(s) 'PATCH, CONNECT, TRACE' from the old version.
New: Microsoft.Storage/stable/2023-04-01/common.json#L34:11
Old: Microsoft.Storage/stable/2023-01-01/common.json#L34:11
1019 - RemovedEnumValue The new version is removing enum value(s) 'PATCH, CONNECT, TRACE' from the old version.
New: Microsoft.Storage/stable/2023-04-01/common.json#L34:11
Old: Microsoft.Storage/stable/2023-01-01/common.json#L34:11
1019 - RemovedEnumValue The new version is removing enum value(s) 'PATCH, CONNECT, TRACE' from the old version.
New: Microsoft.Storage/stable/2023-04-01/common.json#L34:11
Old: Microsoft.Storage/stable/2023-01-01/common.json#L34:11
1019 - RemovedEnumValue The new version is removing enum value(s) 'PATCH, CONNECT, TRACE' from the old version.
New: Microsoft.Storage/stable/2023-04-01/common.json#L34:11
Old: Microsoft.Storage/stable/2023-01-01/common.json#L34:11
1019 - RemovedEnumValue The new version is removing enum value(s) 'PATCH, CONNECT, TRACE' from the old version.
New: Microsoft.Storage/stable/2023-10-01/common.json#L34:11
Old: Microsoft.Storage/stable/2023-01-01/common.json#L34:11
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'allowPermanentDelete' renamed or removed?
New: Microsoft.Storage/stable/2023-04-01/common.json#L77:7
Old: Microsoft.Storage/stable/2023-01-01/common.json#L84:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'allowPermanentDelete' renamed or removed?
New: Microsoft.Storage/stable/2023-04-01/common.json#L77:7
Old: Microsoft.Storage/stable/2023-01-01/common.json#L84:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'allowPermanentDelete' renamed or removed?
New: Microsoft.Storage/stable/2023-04-01/common.json#L77:7
Old: Microsoft.Storage/stable/2023-01-01/common.json#L84:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'signedIdentifiers' renamed or removed?
New: Microsoft.Storage/stable/2023-04-01/table.json#L426:7
Old: Microsoft.Storage/stable/2023-01-01/table.json#L450:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'allowPermanentDelete' renamed or removed?
New: Microsoft.Storage/stable/2023-10-01/common.json#L77:7
Old: Microsoft.Storage/stable/2023-01-01/common.json#L84:7
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L31:9
Old: Microsoft.Storage/stable/2023-01-01/blob.json#L31:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L73:9
Old: Microsoft.Storage/stable/2023-01-01/blob.json#L76:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L119:9
Old: Microsoft.Storage/stable/2023-01-01/blob.json#L122:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L161:9
Old: Microsoft.Storage/stable/2023-01-01/blob.json#L164:9


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

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

Rule Message
Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/6970c8db497399ba952f52a2a9e6d8431bb5137e/specification/storage/resource-manager/Microsoft.Storage/stable/2023-04-01/storage.json",
"old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json",
"details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow,
indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest.
====================
1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.63/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=specification/storage/resource-manager/Microsoft.Storage/stable/2023-04-01/storage.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp
--------------------
2: ERROR: Syntax Error Encountered: Unexpected token in JSON
--------------------
3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-04-01/storage.json:947:4
--------------------
4: ERROR: Referenced file 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-04-01/examples/StorageAccountCreateDnsEndpointTypeToAzureDnsZoned.json' not found
--------------------
5: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-04-01/storage.json:157:12 ($.paths["/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/accountName"].put["x-ms-examples"].StorageAccountCreateDnsEndpointTypeToAzureDnsZone["$ref"])
--------------------
6: FATAL: swagger-document/loader - FAILED
--------------------"
Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/6970c8db497399ba952f52a2a9e6d8431bb5137e/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/blob.json",
"old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/blob.json",
"details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow,
indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest.
====================
1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.63/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/blob.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp
--------------------
2: ERROR: Syntax error: missed comma between flow collection entries
--------------------
3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/storage.json:2001:10
--------------------
4: FATAL: swagger-document/loader - FAILED
--------------------
5: FATAL: Error: Syntax errors encountered.
--------------------
6: Error: Syntax errors encountered.
--------------------"
Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/6970c8db497399ba952f52a2a9e6d8431bb5137e/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/file.json",
"old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/file.json",
"details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow,
indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest.
====================
1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.63/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/file.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp
--------------------
2: ERROR: Syntax error: missed comma between flow collection entries
--------------------
3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/storage.json:2001:10
--------------------
4: FATAL: swagger-document/loader - FAILED
--------------------
5: FATAL: Error: Syntax errors encountered.
--------------------
6: Error: Syntax errors encountered.
--------------------"
Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/6970c8db497399ba952f52a2a9e6d8431bb5137e/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/queue.json",
"old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/queue.json",
"details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow,
indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest.
====================
1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.63/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/queue.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp
--------------------
2: ERROR: Syntax error: missed comma between flow collection entries
--------------------
3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/storage.json:2001:10
--------------------
4: FATAL: swagger-document/loader - FAILED
--------------------
5: FATAL: Error: Syntax errors encountered.
--------------------
6: Error: Syntax errors encountered.
--------------------"
Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/6970c8db497399ba952f52a2a9e6d8431bb5137e/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/storage.json",
"old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json",
"details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow,
indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest.
====================
1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.63/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/storage.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp
--------------------
2: ERROR: Syntax Error Encountered: Unexpected token in JSON
--------------------
3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/storage.json:947:4
--------------------
4: ERROR: Syntax error: missed comma between flow collection entries
--------------------
5: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/storage.json:2001:10
--------------------
6: FATAL: swagger-document/loader - FAILED
--------------------"
Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/6970c8db497399ba952f52a2a9e6d8431bb5137e/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/table.json",
"old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/table.json",
"details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow,
indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest.
====================
1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.63/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/table.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp
--------------------
2: ERROR: Syntax error: missed comma between flow collection entries
--------------------
3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/storage.json:2001:10
--------------------
4: FATAL: swagger-document/loader - FAILED
--------------------
5: FATAL: Error: Syntax errors encountered.
--------------------
6: Error: Syntax errors encountered.
--------------------"
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L73:9
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L119:9
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L512:9
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L573:9
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L626:9
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L1524:5
Old: Microsoft.Storage/preview/2020-08-01-preview/blob.json#L1386:5
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Storage/stable/2023-04-01/blob.json#L1539:5
Old: Microsoft.Storage/preview/2020-08-01-preview/blob.json#L1397:5
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Storage/stable/2023-04-01/file.json#L79:9
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.Storage/stable/2023-04-01/file.json#L131:9
️❌CredScan: 0 Errors, 0 Warnings failed [Detail]
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
Rule Message
LintDiffToolException "details":""stack":"ParserError: Error parsing /mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-04-01/storagetasks.json: missed comma between flow collection entries (421:28)\n\n 418
️❌Avocado: 311 Errors, 0 Warnings failed [Detail]

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

Rule Message
UNREFERENCED_JSON_FILE The swagger JSON file is not referenced from the readme file.
readme: specification/storage/resource-manager/readme.md
json: Microsoft.Storage/stable/2023-04-01/blob.json
UNREFERENCED_JSON_FILE The swagger JSON file is not referenced from the readme file.
readme: specification/storage/resource-manager/readme.md
json: Microsoft.Storage/stable/2023-04-01/common.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersClearLegalHold.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersDelete.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersDeleteImmutabilityPolicy.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersExtendImmutabilityPolicy.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersGet.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersGetImmutabilityPolicy.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersGetWithAllowProtectedAppendWritesAll.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersLease_Acquire.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersLease_Break.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersList.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersLockImmutabilityPolicy.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersPatch.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/storage/resource-manager/readme.md
json: stable/2023-04-01/examples/BlobContainersPut.json
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 0 Errors, 0 Warnings failed [Detail]
️❌SemanticValidation: 12 Errors, 0 Warnings failed [Detail]
Rule Message
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-04-01/storage.json#L947:5
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-04-01/storage.json#L947:5
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-04-01/storage.json#L947:5
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-04-01/storage.json#L947:5
JSON_PARSING_ERROR Json parsing error: invalid symbol
JsonUrl: Microsoft.Storage/stable/2023-04-01/storagetasks.json#L420:9
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-04-01/storage.json#L947:5
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-10-01/storage.json#L947:5
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-10-01/storage.json#L947:5
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-10-01/storage.json#L947:5
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-10-01/storage.json#L947:5
JSON_PARSING_ERROR Json parsing error: invalid symbol
JsonUrl: Microsoft.Storage/stable/2023-10-01/storagetasks.json#L420:9
JSON_PARSING_ERROR Json parsing error: unexpected token
JsonUrl: Microsoft.Storage/stable/2023-10-01/storage.json#L947:5
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌SpellCheck: 18 Errors, 0 Warnings failed [Detail]

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

Rule Message
HowToFix Unknown word (perfix), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-04-01/storage.json#L2461:101
HowToFix Unknown word (dualstack), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-04-01/storage.json#L3839:90
HowToFix Unknown word (Uptier), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-04-01/storage.json#L5187:14
HowToFix Unknown word (Uptier), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-04-01/storage.json#L5188:38
HowToFix Unknown word (implemntation), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-04-01/storage.json#L5189:138
HowToFix Unknown word (Uptier), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-04-01/storage.json#L5194:10
HowToFix Unknown word (uptier), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-04-01/storage.json#L5198:118
HowToFix Unknown word (intiated), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-04-01/storage.json#L5842:67
HowToFix Unknown word (paramaters), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-04-01/storage.json#L5880:27
HowToFix Unknown word (perfix), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-10-01/storage.json#L2478:101
HowToFix Unknown word (dualstack), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-10-01/storage.json#L3856:90
HowToFix Unknown word (Uptier), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-10-01/storage.json#L5204:14
HowToFix Unknown word (Uptier), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-10-01/storage.json#L5205:38
HowToFix Unknown word (implemntation), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-10-01/storage.json#L5206:138
HowToFix Unknown word (Uptier), please fix the error or add words to ./custom-words.txt
path: Microsoft.Storage/stable/2023-10-01/storage.json#L5211:10
️️✔️Lint(RPaaS) succeeded [Detail]
Rule Message
LintRpaasToolException "details":""stack":"ParserError: Error parsing /mnt/vss/_work/1/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-04-01/storagetasks.json: missed comma between flow collection entries (421:28)\n\n 418
️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Nov 15, 2023

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
Rule Message
RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=398889&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 1 "
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking


️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed [Logs] Generate from 5e2ec79b203a555050fe8827e73ae28e86b478c7. 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] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 714 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 807 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 714 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
  • Azure.ResourceManager.Storage [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from 5e2ec79b203a555050fe8827e73ae28e86b478c7. 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] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh] notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.4
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.4` to update!
    cmderr	[automation_generate.sh] npm notice
    warn	No file changes detected after generation
    warn	No package detected after generation
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from 5e2ec79b203a555050fe8827e73ae28e86b478c7. 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
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-storage-generated [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 5e2ec79b203a555050fe8827e73ae28e86b478c7. 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/storage/armstorage [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 5e2ec79b203a555050fe8827e73ae28e86b478c7. 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	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
  • ️✔️@azure/arm-storage [View full logs]  [Preview SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from 5e2ec79b203a555050fe8827e73ae28e86b478c7. 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]  notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.4
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.4` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  • ️✔️storage [View full logs]  [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from 5e2ec79b203a555050fe8827e73ae28e86b478c7. 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
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ️✔️Az.storage.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.storage.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Nov 15, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/storage/armstorage There is no API change compared with the previous version
Java azure-resourcemanager-storage-generated https://apiview.dev/Assemblies/Review/d5f8681c146e401b9e84becac22aa842
JavaScript @azure/arm-storage There is no API change compared with the previous version

@cagrawal-msft
Copy link
Contributor Author

Following files have been changed in this PR, other files are same as older versions.

/main/specification/storage/resource-manager/Microsoft.Storage/stable/2023-04-01 is picked from:
https://msazure.visualstudio.com/One/_git/Storage-SRP?path=/src/Swagger/Microsoft.Storage/stable/2023-04-01&version=GBmaster&_a=contents

/main/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/storage.json

/main/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/examples/LocalUserCreate.json
/main/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/examples/LocalUserGet.json
/main/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/examples/LocalUserUpdate.json

New files
/main/specification/storage/resource-manager/Microsoft.Storage/stable/2023-10-01/examples/LocalUsersListNFSv3Enabled.json

@blueww
Copy link
Member

blueww commented Nov 16, 2023

@cagrawal-msft

Please split the commits as following, or the PR is very difficult to review.

  • 1 Commit to copy from old API version (without any change)
  • 1 commit to change API version.
  • following commits for API changes of the features.

See example PR of adding before API version: https://github.com/Azure/azure-rest-api-specs/pull/23918/commits

@cagrawal-msft
Copy link
Contributor Author

@blueww I have added commits as you asked. Can you review it now? Let me know if anything else is required from my side.

@blueww
Copy link
Member

blueww commented Nov 21, 2023

@blueww I have added commits as you asked. Can you review it now? Let me know if anything else is required from my side.

As I see, the commit in the PR is still not organized as my comments.
The new SRP API version swagger must based on latest public SRP API version , in this case it's azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01 at main · Azure/azure-rest-api-specs (github.com)
You need copy from the latest public API version swagger to the API version folder, make a commit, then change the API version to new, make a commit, then add you swagger change. Without this commit origination, it's very hard to review the swagger PR.

This is a similar comment for before swagger PR, you can get more details: #23918 (comment)

@blueww
Copy link
Member

blueww commented Nov 21, 2023

Besides that, I see you added 2 API version (2023-04-01, 2023-10-01):

  1. Which API version would you like client tool be cased on? You need change Readme.md files add a new tag for a new API version, and specify which is the default API version. The client tool will develop with default API version.
  2. Normally we will only add at most 1 API version with 1 swagger PR.

The PR is much different from a normal SRP swagger PR for new API version. SRP team owns swagger. You can reference the before PRs or contact the creator of these PRs to get more details how to build a good SRP swagger PR for new API version:
#21500
#23918
#19357

"x-ms-examples": {
"ListLocalUsers": {
"$ref": "./examples/LocalUsersList.json"
}
Copy link
Member

Choose a reason for hiding this comment

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

missed comma between examples.

Suggested change
}
},

@@ -0,0 +1,863 @@
{
Copy link
Member

Choose a reason for hiding this comment

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

Why the file is here?
As I Storage Task has changed name to Storage Action, and added to a new RP: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/storageactions/resource-manager

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

11 similar comments
Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

Copy link
Contributor

Hi, @cagrawal-msft. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

3 similar comments
Copy link
Contributor

Hi, @cagrawal-msft. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

Copy link
Contributor

Hi, @cagrawal-msft. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

Copy link
Contributor

Hi, @cagrawal-msft. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

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

Successfully merging this pull request may close these issues.

3 participants