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

add canFetchContext parameter to individual get request #17708

Merged
merged 28 commits into from
Mar 14, 2022

Conversation

vutran01
Copy link
Contributor

@vutran01 vutran01 commented Feb 8, 2022

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

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 langauge 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 apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • 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-workflow-bot
Copy link

openapi-workflow-bot bot commented Feb 8, 2022

Hi, @vutran01 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. [email protected]


    In reply to: 1032845494


    In reply to: 1032845494

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 8, 2022

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    1043 - AddingOptionalParameter The optional parameter 'canFetchContent' was added in the new version.
    New: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L143:9
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R1005 - GetInOperationName 'GET' operation 'Workbooks_RevisionsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L337
    ⚠️ R1005 - GetInOperationName 'GET' operation 'Workbooks_RevisionsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L337
    ⚠️ R1005 - GetInOperationName 'GET' operation 'Workbooks_RevisionGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L379
    ⚠️ R1005 - GetInOperationName 'GET' operation 'Workbooks_RevisionGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L379
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'revisions' with immediate parent 'Workbook', must have a list by immediate parent operation.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L476
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'revisions' with immediate parent 'Workbook', must have a list by immediate parent operation.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L476
    ⚠️ R4021 - DescriptionAndTitleMissing 'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L470
    ⚠️ R4021 - DescriptionAndTitleMissing 'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L470
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksList2
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L75
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksList2
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L75
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksList
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L129
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksList
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L129
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookGet
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L174
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookGet
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L174
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookDelete
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L217
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookDelete
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L217
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookAdd
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L272
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookAdd
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L272
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookUpdate
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L324
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookUpdate
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L324
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/applicationinsights/resource-manager/readme.md
    tag: specification/applicationinsights/resource-manager/readme.md#tag-package-2022-02-01
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Feb 8, 2022

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.


    In reply to: 1032845508


    In reply to: 1032845508

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 8, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go-track2 - armapplicationinsights - 0.3.0
    azure-sdk-for-python-track2 - track2_azure-mgmt-applicationinsights - 2.1.0
    +	Operation WorkbooksOperations.get has a new signature
    azure-sdk-for-go - appinsights/mgmt/2020-02-02/insights - v62.2.0
    +	Const `ItemTypeFolder` has been removed
    azure-sdk-for-go - appinsights/mgmt/2015-05-01/insights - v62.2.0
    +	Const `Folder` has been removed
    azure-sdk-for-go - preview/appinsights/mgmt/2022-01-11-preview/insights - v62.2.0
    +	Function `WorkbooksClient.GetPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    +	Function `WorkbooksClient.Get` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    azure-sdk-for-go - preview/appinsights/mgmt/2021-11-01-preview/insights - v62.2.0
    +	Const `ItemTypeFolder` has been removed
    +	Function `WorkbooksClient.GetPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    +	Function `WorkbooksClient.Get` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    azure-sdk-for-go - preview/appinsights/mgmt/2020-02-02-preview/insights - v61.5.0
    +	Package was removed
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1cda8f7. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.ApplicationInsights [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1cda8f7. 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! 8.3.1 -> 8.5.4
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.4>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-applicationinsights [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation WorkbooksOperations.get has a new signature
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1cda8f7. SDK Automation 14.0.0
      command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️appinsights/mgmt/2020-02-02/insights [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Const `ItemTypeFolder` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `ItemTypeNone`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 1 additive change(s).
    • ️✔️appinsights/mgmt/2015-05-01/insights [View full logs
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Const `Folder` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `None`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 1 additive change(s).
    • ️✔️preview/appinsights/mgmt/2022-01-11-preview/insights [View full logs
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `WorkbooksClient.Get` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog] - Function `WorkbooksClient.GetPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog]
      info	[Changelog] Total 2 breaking change(s), 0 additive change(s).
    • ️✔️preview/appinsights/mgmt/2021-11-01-preview/insights [View full logs
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `WorkbooksClient.Get` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog] - Function `WorkbooksClient.GetPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog] - Const `ItemTypeFolder` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `ItemTypeNone`
      info	[Changelog]
      info	[Changelog] Total 3 breaking change(s), 1 additive change(s).
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1cda8f7. 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
    • ️✔️armapplicationinsights [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `WorkbookTemplateLocalizedGallery.TemplateData` has been changed from `map[string]interface{}` to `interface{}`
      info	[Changelog] - Type of `WorkbookTemplateProperties.TemplateData` has been changed from `map[string]interface{}` to `interface{}`
      info	[Changelog] - Function `OperationsListResult.MarshalJSON` has been removed
      info	[Changelog] - Function `NewOperationsClient` has been removed
      info	[Changelog] - Function `*OperationsClientListPager.Err` has been removed
      info	[Changelog] - Function `InnerErrorTrace.MarshalJSON` has been removed
      info	[Changelog] - Function `*OperationsClientListPager.PageResponse` has been removed
      info	[Changelog] - Function `*InnerError.UnmarshalJSON` has been removed
      info	[Changelog] - Function `*OperationsClient.List` has been removed
      info	[Changelog] - Function `OperationListResult.MarshalJSON` has been removed
      info	[Changelog] - Function `*OperationsClientListPager.NextPage` has been removed
      info	[Changelog] - Function `InnerError.MarshalJSON` has been removed
      info	[Changelog] - Function `WorkbookInnerErrorTrace.MarshalJSON` has been removed
      info	[Changelog] - Function `WorkbookTemplateErrorBody.MarshalJSON` has been removed
      info	[Changelog] - Struct `AnnotationError` has been removed
      info	[Changelog] - Struct `ErrorDefinition` has been removed
      info	[Changelog] - Struct `ErrorResponse` has been removed
      info	[Changelog] - Struct `ErrorResponseLinkedStorage` has been removed
      info	[Changelog] - Struct `ErrorResponseLinkedStorageError` has been removed
      info	[Changelog] - Struct `InnerError` has been removed
      info	[Changelog] - Struct `InnerErrorTrace` has been removed
      info	[Changelog] - Struct `MyWorkbookError` has been removed
      info	[Changelog] - Struct `Operation` has been removed
      info	[Changelog] - Struct `OperationDisplay` has been removed
      info	[Changelog] - Struct `OperationInfo` has been removed
      info	[Changelog] - Struct `OperationListResult` has been removed
      info	[Changelog] - Struct `OperationLive` has been removed
      info	[Changelog] - Struct `OperationsClient` has been removed
      info	[Changelog] - Struct `OperationsClientListOptions` has been removed
      info	[Changelog] - Struct `OperationsClientListPager` has been removed
      info	[Changelog] - Struct `OperationsClientListResponse` has been removed
      info	[Changelog] - Struct `OperationsClientListResult` has been removed
      info	[Changelog] - Struct `OperationsListResult` has been removed
      info	[Changelog] - Struct `WorkItemConfigurationError` has been removed
      info	[Changelog] - Struct `WorkbookError` has been removed
      info	[Changelog] - Struct `WorkbookErrorDefinition` has been removed
      info	[Changelog] - Struct `WorkbookInnerErrorTrace` has been removed
      info	[Changelog] - Struct `WorkbookTemplateError` has been removed
      info	[Changelog] - Struct `WorkbookTemplateErrorBody` has been removed
      info	[Changelog] - Struct `WorkbookTemplateErrorFieldContract` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New field `Etag` in struct `Component`
      info	[Changelog] - New field `ForceCustomerStorageForProfiler` in struct `ComponentProperties`
      info	[Changelog] - New field `LaMigrationDate` in struct `ComponentProperties`
      info	[Changelog] - New field `Name` in struct `ComponentProperties`
      info	[Changelog] - New field `DisableLocalAuth` in struct `ComponentProperties`
      info	[Changelog] - New field `WorkspaceResourceID` in struct `ComponentProperties`
      info	[Changelog] - New field `CanFetchContent` in struct `WorkbooksClientGetOptions`
      info	[Changelog]
      info	[Changelog] Total 66 breaking change(s), 3 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1cda8f7. 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
      cmderr	[automation_init.sh]  deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
      cmderr	[automation_init.sh]  @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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-appinsights [View full logs]  [Release 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]Release - Generate from 1cda8f7. 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] WARN 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
    • ️✔️applicationinsights [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Feb 8, 2022

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.


    In reply to: 1032848126


    In reply to: 1032848126

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Feb 8, 2022

    Hi @vutran01, 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.


    In reply to: 1032848255


    In reply to: 1032848255

    @akning-ms akning-ms added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 9, 2022
    @akning-ms
    Copy link
    Contributor

    @ArcturusZhang to help check why GO SDK T1 generation failure

    @gardnerjr
    Copy link
    Contributor

    these are due to a description changes which was modified to fixed the wrong description. are the description locked down and we're not suppose to change them once written?
    In reply to: 1056561702

    No, it is due to change description caused conflict with another definition in another file. lead to linter rule exception. it is not means you can not change description, better to keep consistent for same parameter in different place

    @vutran01 @akning-ms i don't get this. is this implying that EVERY "description" in the whole resource type has to say "application insights" even though a lot of the resource types have nothing to do with application insights? or was the suggestion here to just fix the 3 workbooks, templates, and private workbooks resource types that we own?

    we don't want the docs to say application insights when these resource types have nothing to do with application insights.

    @azure-pipelines
    Copy link

    azure-pipelines bot commented Mar 11, 2022

    Command 'run

    In' is not supported by Azure Pipelines.



    Supported commands

    • help:
      • Get descriptions, examples and documentation about supported commands
      • Example: help "command_name"
    • list:
      • List all pipelines for this repository using a comment.
      • Example: "list"
    • run:
      • Run all pipelines or specific pipelines for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify specific pipelines to run.
      • Example: "run" or "run pipeline_name, pipeline_name, pipeline_name"
    • where:
      • Report back the Azure DevOps orgs that are related to this repository and org
      • Example: "where"

    See additional documentation.

    In reply to: 1065584777

    @azure-pipelines
    Copy link

    azure-pipelines bot commented Mar 11, 2022

    Command 'run

    In' is not supported by Azure Pipelines.



    Supported commands

    • help:
      • Get descriptions, examples and documentation about supported commands
      • Example: help "command_name"
    • list:
      • List all pipelines for this repository using a comment.
      • Example: "list"
    • run:
      • Run all pipelines or specific pipelines for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify specific pipelines to run.
      • Example: "run" or "run pipeline_name, pipeline_name, pipeline_name"
    • where:
      • Report back the Azure DevOps orgs that are related to this repository and org
      • Example: "where"

    See additional documentation.

    In reply to: 1065584970

    @azure-pipelines
    Copy link

    azure-pipelines bot commented Mar 11, 2022

    Command 'run

    In' is not supported by Azure Pipelines.



    Supported commands

    • help:
      • Get descriptions, examples and documentation about supported commands
      • Example: help "command_name"
    • list:
      • List all pipelines for this repository using a comment.
      • Example: "list"
    • run:
      • Run all pipelines or specific pipelines for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify specific pipelines to run.
      • Example: "run" or "run pipeline_name, pipeline_name, pipeline_name"
    • where:
      • Report back the Azure DevOps orgs that are related to this repository and org
      • Example: "where"

    See additional documentation.

    In reply to: 1065585061

    @azure-pipelines
    Copy link

    azure-pipelines bot commented Mar 11, 2022

    Command 'run

    In' is not supported by Azure Pipelines.



    Supported commands

    • help:
      • Get descriptions, examples and documentation about supported commands
      • Example: help "command_name"
    • list:
      • List all pipelines for this repository using a comment.
      • Example: "list"
    • run:
      • Run all pipelines or specific pipelines for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify specific pipelines to run.
      • Example: "run" or "run pipeline_name, pipeline_name, pipeline_name"
    • where:
      • Report back the Azure DevOps orgs that are related to this repository and org
      • Example: "where"

    See additional documentation.

    In reply to: 1065585166


    In reply to: 1065585166

    @akning-ms
    Copy link
    Contributor

    these are due to a description changes which was modified to fixed the wrong description. are the description locked down and we're not suppose to change them once written?
    In reply to: 1056561702

    No, it is due to change description caused conflict with another definition in another file. lead to linter rule exception. it is not means you can not change description, better to keep consistent for same parameter in different place

    @vutran01 @akning-ms i don't get this. is this implying that EVERY "description" in the whole resource type has to say "application insights" even though a lot of the resource types have nothing to do with application insights? or was the suggestion here to just fix the 3 workbooks, templates, and private workbooks resource types that we own?

    we don't want the docs to say application insights when these resource types have nothing to do with application insights.

    It is due to a limitation for Linter tool which same parameter name has different description, it cause Linter exception and block linter validation. We are improving it in next version.

    @ArcturusZhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @ArcturusZhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @akning-ms akning-ms merged commit 1cda8f7 into Azure:main Mar 14, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    * set default tag to package-2021-03-only
    
    * new default tag and add only workbooks to release
    
    * update package tag with same RP as last package
    
    * update tag name
    
    * Update readme.python.md
    
    * change definition name
    
    * remove operations
    
    * fix missingtypeobject in workbooks
    
    * fix up model validation errors
    
    * setup initial repo
    
    * add missing canfetchcontent
    
    * change kind to only support shared
    
    * name needs to be different
    
    * fix invalide format examples
    
    * enum should not change till a new apiversion
    
    * make new param last
    
    * change name back to kind
    
    * fix up descriptions and examples
    
    * fix up examples
    
    * ran prettier
    
    * update description to remove appinsights
    
    * restore back text
    
    * restore description
    
    * restore
    
    Co-authored-by: msyyc <[email protected]>
    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-SdkBreakingChange-Go-V2 CI-BreakingChange-Go-V2 CI-FixRequiredOnFailure FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants