Skip to content

S360 Item - Missing Get SubscriptionOperations for 2021-10-01 version.#24395

Merged
rkmanda merged 10 commits intoAzure:mainfrom
abhaygill338:sub-operations-missing-2021-10-01
Jul 7, 2023
Merged

S360 Item - Missing Get SubscriptionOperations for 2021-10-01 version.#24395
rkmanda merged 10 commits intoAzure:mainfrom
abhaygill338:sub-operations-missing-2021-10-01

Conversation

@abhaygill338
Copy link
Copy Markdown
Contributor

@abhaygill338 abhaygill338 commented Jun 12, 2023

Resolving S360 Item of Missing Get Subscription Operations for 2021-10-01 version in the swagger. https://portal.azure-devex-tools.com/amekpis/completeness/detail?errorId=623EE52B-F0B6-4F60-B73E-CCE24ADABAD6

@openapi-workflow-bot
Copy link
Copy Markdown

Hi, @abhaygill338 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Jun 12, 2023

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    subscriptions.json 2021-10-01(41f8f34) 2021-10-01(main)
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L121:5
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 3 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.3) new version base version
    package-2021-10 package-2021-10(41f8f34) package-2021-10(main)

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'operationId'.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L158
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L158
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L158


    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.Subscription/stable/2021-10-01/subscriptions.json#L190
    PathForPutOperation The path for 'put' operation must be under a subscription and resource group.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L205
    ResourceNameRestriction The resource name parameter 'aliasName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L205
    PutRequestResponseSchemeArm A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Alias_Create' Request Model: 'parameters[1].schema' Response Model: 'responses[200].schema'
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L206
    PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L215
    PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L215
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L231
    LroPostReturn A LRO POST operation must have both 200 & 202 return codes.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L346
    PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L346
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L373
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L407
    PathForPutOperation The path for 'put' operation must be under a subscription and resource group.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L428
    PutRequestResponseSchemeArm A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'SubscriptionPolicy_AddUpdatePolicyForTenant' Request Model: 'parameters[0].schema' Response Model: 'responses[200].schema'
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L429
    PutResponseSchemaDescription Any Put MUST contain 200 and 201 return codes.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L437
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L476
    GetCollectionResponseSchema The response in the GET collection operation 'SubscriptionPolicy_ListPolicyForTenant' does not match the response definition in the individual GET operation 'BillingAccount_GetPolicy' .
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L494
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L539
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L651
    TopLevelResourcesListBySubscription The top-level resource 'SubscriptionAliasResponse' does not have list by subscription operation, please add it.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L763
    ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L806
    GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L964
    TopLevelResourcesListBySubscription The top-level resource 'GetTenantPolicyResponse' does not have list by subscription operation, please add it.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L971
    TopLevelResourcesListBySubscription The top-level resource 'BillingAccountPoliciesResponse' does not have list by subscription operation, please add it.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1020
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1054
    GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1090
    ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1127
    XmsParameterLocation The parameter 'apiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1157
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L28
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L28
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
    Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L61
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/subscription/resource-manager/readme.md
    tag: specification/subscription/resource-manager/readme.md#tag-package-2021-10
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Jun 12, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking




    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0f39a2d. 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/subscription/armsubscription [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `Provisioning` with values `ProvisioningAccepted`, `ProvisioningPending`, `ProvisioningSucceeded`
      info	[Changelog] - New function `*ClientFactory.NewOperationClient() *OperationClient`
      info	[Changelog] - New function `NewOperationClient(azcore.TokenCredential, *arm.ClientOptions) (*OperationClient, error)`
      info	[Changelog] - New function `*OperationClient.Get(context.Context, string, *OperationClientGetOptions) (OperationClientGetResponse, error)`
      info	[Changelog] - New struct `CreationResult`
      info	[Changelog] - New field `ProvisioningState` in struct `AcceptOwnershipStatusResponse`
      info	[Changelog] - New field `Tags`, `TenantID` in struct `Subscription`
      info	[Changelog] - New field `Country`, `CountryCode`, `DefaultDomain`, `DisplayName`, `Domains`, `TenantCategory`, `TenantType` in struct `TenantIDDescription`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 12 additive change(s).
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 0f39a2d. 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: 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 minor version of npm available! 9.5.1 -> 9.8.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.8.0` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-subscription [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group SubscriptionOperationOperations
      info	[Changelog]   - Model Subscription has a new parameter tags
      info	[Changelog]   - Model Subscription has a new parameter tenant_id
      info	[Changelog]   - Model TenantIdDescription has a new parameter country
      info	[Changelog]   - Model TenantIdDescription has a new parameter country_code
      info	[Changelog]   - Model TenantIdDescription has a new parameter default_domain
      info	[Changelog]   - Model TenantIdDescription has a new parameter display_name
      info	[Changelog]   - Model TenantIdDescription has a new parameter domains
      info	[Changelog]   - Model TenantIdDescription has a new parameter tenant_category
      info	[Changelog]   - Model TenantIdDescription has a new parameter tenant_type
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0f39a2d. 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
    • ️✔️@azure/arm-subscriptions [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group SubscriptionOperation
      info	[Changelog]   - Added Interface SubscriptionCreationResult
      info	[Changelog]   - Added Interface SubscriptionOperationGetHeaders
      info	[Changelog]   - Added Interface SubscriptionOperationGetOptionalParams
      info	[Changelog]   - Added Type Alias SubscriptionOperationGetResponse
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 0f39a2d. 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]  old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
      warn	No file changes detected after generation
    • ️✔️subscription [View full logs
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 0f39a2d. 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.subscription.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.subscription.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Jun 12, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/subscription/armsubscription https://apiview.dev/Assemblies/Review/29dd6bb2802d4477bcff0c81d964690b
    .Net Azure.ResourceManager.Subscription https://apiview.dev/Assemblies/Review/cc8874e4a9a74cb0aee505657b32aea8
    JavaScript @azure/arm-subscriptions https://apiview.dev/Assemblies/Review/3153b3116fd54c2895dcdf39cf43a808

    @openapi-workflow-bot
    Copy link
    Copy Markdown

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot
    Copy link
    Copy Markdown

    Hi @abhaygill338, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link
    Copy Markdown

    The automation detected this Pull Request introduces breaking changes to an existing API version and hence it added the NewApiVersionRequired label. This means you cannot proceed with merging this PR until you complete one of the following action items:

    - A) Submit a new PR instead of this one, or modify this PR, so that it introduces a new API version instead of introducing breaking changes to an existing API version. The automation will remove the label once it detects there are no more breaking changes.
    - B) OR you can request an approval of the breaking changes, get it reviewed, and approved. The reviewer will add Approved-BreakingChange label if they approve.

    For additional guidance, please see https://aka.ms/NewApiVersionRequired

    @abhaygill338 abhaygill338 changed the title S320 Item - Missing Get SubscriptionOperations for 2021-10-01 version. S360 Item - Missing Get SubscriptionOperations for 2021-10-01 version. Jun 12, 2023
    @openapi-workflow-bot openapi-workflow-bot Bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 12, 2023
    @openapi-workflow-bot openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 12, 2023
    @abhaygill338 abhaygill338 requested a review from zizw123 June 14, 2023 07:16
    @abhaygill338 abhaygill338 added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested labels Jun 15, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added NewApiVersionRequired and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Jun 29, 2023
    @abhaygill338 abhaygill338 added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required and removed NewApiVersionRequired labels Jun 29, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added NewApiVersionRequired ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Jun 30, 2023
    @abhaygill338 abhaygill338 added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required and removed NewApiVersionRequired labels Jun 30, 2023
    @abhaygill338 abhaygill338 reopened this Jun 30, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added NewApiVersionRequired and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Jun 30, 2023
    @abhaygill338 abhaygill338 added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NewApiVersionRequired and removed NewApiVersionRequired labels Jun 30, 2023
    @abhaygill338 abhaygill338 assigned mentat9 and unassigned rkmanda Jul 3, 2023
    @openapi-workflow-bot openapi-workflow-bot Bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 4, 2023
    @mentat9
    Copy link
    Copy Markdown
    Member

    mentat9 commented Jul 5, 2023

    Reviewed suppression.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager SuppressionReviewRequired

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    8 participants