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.

Sign up for GitHub

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

Jump to bottom

[Test] Add enum SDFLEX #3690

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Test] Add enum SDFLEX #3690

wants to merge 1 commit into from
+2 −1

Conversation

ankhyk
Copy link

@ankhyk ankhyk commented Nov 14, 2023

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-pipeline-app-test openapi-pipeline-app-test
Copy link

Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

@openapi-pipeline-app-test openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023 •
edited
Loading

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
baremetalinfrastructure.json 2021-08-09(08df697) 2021-08-09(main)
Rule Message
❌ 1020 - AddedEnumValue The new version is adding enum value(s) 'SDFLEX' from the old version.
New: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L364:9
Old: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L364:9
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
There are no breaking changes.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-2021-08-09 package-2021-08-09(08df697) package-2021-08-09(main)

The following errors/warnings exist before current PR submission:

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

Rule Message
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L144
❌ ResourceNameRestriction The resource name parameter 'azureBareMetalInstanceName' should be defined with a 'pattern' restriction.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L159
❌ MissingTypeObject The schema 'AzureBareMetalInstancesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L251
❌ MissingTypeObject The schema 'AzureBareMetalInstance' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L267
❌ TrackedResourcesMustHavePut The tracked resource AzureBareMetalInstance does not have a corresponding put operation.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L267
❌ MissingTypeObject The schema 'AzureBareMetalInstanceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L287
❌ ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L341
❌ MissingTypeObject The schema 'HardwareProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L362
❌ MissingTypeObject The schema 'Disk' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L435
❌ MissingTypeObject The schema 'StorageProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L455
❌ MissingTypeObject The schema 'OSProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L475
❌ MissingTypeObject The schema 'NetworkProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L498
❌ MissingTypeObject The schema 'IpAddress' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L518
❌ MissingTypeObject The schema 'Result' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L563
❌ MissingTypeObject The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L598
❌ MissingTypeObject The schema 'ErrorDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L607
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L52
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L55
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L89
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L92
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L95
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L137
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L174
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L177
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L180
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L218
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L221
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L224
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L275
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L282
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand] 
Validation passes for Lint(RPaaS).
️️✔️Avocado succeeded [Detail] [Expand] 
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand] 
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️❌~[NotRequired_Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️~[NotRequired_Staging] TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand] 
Validation passed for PoliCheck.
️️✔️[NotRequired_Staging] PrettierCheck succeeded [Detail] [Expand] 
Validation passes for PrettierCheck.
️❌[NotRequired_Staging] SpellCheck: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ HowToFix Unknown word (SDFLEX), please fix the error or add words to ./custom-words.txt
path: Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json#L370:14
️❌[NotRequired_Staging] SDK Track2 Validation: 13 Errors, 0 Warnings failed [Detail]
  • The following tags are being changed in this PR
    • "https://github.com/openapi-env-test/azure-rest-api-specs/blob/08df6974646ca4823bd127cd8e1090e746ef8ea0/specification/baremetalinfrastructure/resource-manager/readme.md#tag-package-2021-08-09">baremetalinfrastructure/resource-manager/readme.md#package-2021-08-09
The following errors/warnings are introduced by current PR:
Rule Message
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'AzureBareMetalInstancesListResult' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'AzureBareMetalInstance' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'AzureBareMetalInstanceProperties' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'HardwareProfile' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'Disk' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'StorageProfile' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'OSProfile' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'NetworkProfile' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'IpAddress' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'Result' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'ErrorResponse' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ MissingTypeObject "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The schema 'ErrorDefinition' is considered an object but without a 'type:object',
please add the missing 'type:object'."
❌ TrackedResourcesMustHavePut "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"The tracked resource AzureBareMetalInstance does not have a corresponding put operation."
💬 "readme":"baremetalinfrastructure/resource-manager/readme.md",
"tag":"package-2021-08-09",
"details":"openapiValidatorPluginFunc: Validating 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json'"


The following errors/warnings exist before current PR submission:

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023 •
edited
Loading

Swagger Generation Artifacts

️🔄[NotRequired_Staging] ApiDocPreview inProgress [Detail]
️❌[NotRequired_Staging] SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - sdk/resourcemanager/baremetalinfrastructure/armbaremetalinfrastructure - 2.0.0
+	Function `*ClientFactory.NewAzureBareMetalInstancesClient` has been removed
+	Function `*ClientFactory.NewOperationsClient` has been removed
+	Function `NewClientFactory` has been removed
+	Struct `ClientFactory` has been removed

️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from e0d88ca. 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] npm notice
cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.3
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-baremetalinfrastructure [View full logs]  [Preview SDK Changes] 
    info	[Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from e0d88ca. 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/baremetalinfrastructure/armbaremetalinfrastructure [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `NewClientFactory` has been removed
info	[Changelog] - Function `*ClientFactory.NewAzureBareMetalInstancesClient` has been removed
info	[Changelog] - Function `*ClientFactory.NewOperationsClient` has been removed
info	[Changelog] - Struct `ClientFactory` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New value `AzureBareMetalHardwareTypeNamesEnumSDFLEX` added to type alias `AzureBareMetalHardwareTypeNamesEnum`
info	[Changelog]
info	[Changelog] Total 5 breaking change(s), 1 additive change(s).
️⚠️ azure-sdk-for-js warning [Detail]
  • ⚠️Warning [Logs] Generate from e0d88ca. 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
warn	No file changes detected after generation
warn	No package detected after generation
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/baremetalinfrastructure/armbaremetalinfrastructure Create ApiView failed. Please ask PR assignee for help
Java azure-resourcemanager-baremetalinfrastructure Create ApiView failed. Please ask PR assignee for help
Swagger Microsoft.BareMetalInfrastructure Create ApiView failed. Please ask PR assignee for help

@azure-sdk azure-sdk mentioned this pull request Nov 14, 2023
Draft
This was referenced Nov 14, 2023
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
ARMReview ARMSignedOff CI-BreakingChange-Go ReadyForAPITest resource-manager
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ankhyk @AzureRestAPISpecReview