Skip to content

Adding new preview version "2023-11-01-preview" with new APIs#26528

Merged
sjanamma merged 14 commits into
Azure:mainfrom
vipray-ms:main
Nov 28, 2023
Merged

Adding new preview version "2023-11-01-preview" with new APIs#26528
sjanamma merged 14 commits into
Azure:mainfrom
vipray-ms:main

Conversation

@vipray-ms
Copy link
Copy Markdown
Member

@vipray-ms vipray-ms commented Nov 2, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

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

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Nov 2, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Nov 2, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
NewRelic.json 2023-11-01-preview(03e7dcc) 2022-07-01(main)
NewRelic.json 2023-11-01-preview(03e7dcc) 2023-10-01-preview(main)
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 37 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-2023-11-01-preview package-2023-11-01-preview(03e7dcc) default(main)

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

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

Rule Message Related RPC [For API reviewers]
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1329
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1331
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1334
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1345
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1358
⚠️ RequiredReadOnlySystemData The response of operation:'MonitoredSubscriptions_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1373
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1382
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1384
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1387
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1413
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1426
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Monitors_GetMonitoredSubscriptions
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1430
⚠️ RequiredReadOnlySystemData The response of operation:'MonitoredSubscriptions_CreateorUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1436
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1448
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1450
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1453
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1479
⚠️ ParameterDescription Parameter should have a description.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1481
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1505
⚠️ RequiredReadOnlySystemData The response of operation:'MonitoredSubscriptions_Update' is defined without 'systemData'. Consider adding the systemData to the response.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1516
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1525
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1527
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1530
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1556
⚠️ ParameterDescription Parameter should have a description.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1558
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1584
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1604
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1606
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1609
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1635


The following errors/warnings exist before current PR submission:

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

Rule Message
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L325
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L493
LroLocationHeader A 202 response should include an Location response header.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L526
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L558
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L610
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L662
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L717
LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L718
PostResponseCodes An async POST operation must set ''x-ms-long-running-operation' : true'.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L718
LroLocationHeader A 202 response should include an Location response header.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L754
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L782
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L837
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Monitors' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L842
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1000
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1052
ResourceNameRestriction The resource name parameter 'ruleSetName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1052
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1187
LroLocationHeader A 202 response should include an Location response header.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1224
ResourceNameRestriction The resource name parameter 'monitorName' should be defined with a 'pattern' restriction.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L1718
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L68
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L70
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L77
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L83
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L107
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L109
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L112
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L131
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L155
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L157
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json#L160
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Nov 2, 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-python warning [Detail]
  • ⚠️Warning [Logs] Generate from ff50e7f9e7261cc2e20734aa583a7abd318c5a02. 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]
    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
  • ️✔️track2_azure-mgmt-newrelicobservability [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation MonitorsOperations.list_linked_resources
    info	[Changelog]   - Added operation group BillingInfoOperations
    info	[Changelog]   - Added operation group ConnectedPartnerResourcesOperations
    info	[Changelog]   - Added operation group MonitoredSubscriptionsOperations
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from ff50e7f9e7261cc2e20734aa583a7abd318c5a02. 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-newrelicobservability [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from ff50e7f9e7261cc2e20734aa583a7abd318c5a02. 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/newrelic/armnewrelicobservability [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New enum type `ConfigurationName` with values `ConfigurationNameDefault`
    info	[Changelog] - New enum type `PatchOperation` with values `PatchOperationActive`, `PatchOperationAddBegin`, `PatchOperationAddComplete`, `PatchOperationDeleteBegin`, `PatchOperationDeleteComplete`
    info	[Changelog] - New enum type `Status` with values `StatusActive`, `StatusDeleting`, `StatusFailed`, `StatusInProgress`
    info	[Changelog] - New function `NewBillingInfoClient(string, azcore.TokenCredential, *arm.ClientOptions) (*BillingInfoClient, error)`
    info	[Changelog] - New function `*BillingInfoClient.Get(context.Context, string, string, *BillingInfoClientGetOptions) (BillingInfoClientGetResponse, error)`
    info	[Changelog] - New function `*ClientFactory.NewBillingInfoClient() *BillingInfoClient`
    info	[Changelog] - New function `*ClientFactory.NewConnectedPartnerResourcesClient() *ConnectedPartnerResourcesClient`
    info	[Changelog] - New function `*ClientFactory.NewMonitoredSubscriptionsClient() *MonitoredSubscriptionsClient`
    info	[Changelog] - New function `NewConnectedPartnerResourcesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ConnectedPartnerResourcesClient, error)`
    info	[Changelog] - New function `*ConnectedPartnerResourcesClient.NewListPager(string, string, *ConnectedPartnerResourcesClientListOptions) *runtime.Pager[ConnectedPartnerResourcesClientListResponse]`
    info	[Changelog] - New function `NewMonitoredSubscriptionsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*MonitoredSubscriptionsClient, error)`
    info	[Changelog] - New function `*MonitoredSubscriptionsClient.BeginCreateorUpdate(context.Context, string, string, ConfigurationName, MonitoredSubscriptionProperties, *MonitoredSubscriptionsClientBeginCreateorUpdateOptions) (*runtime.Poller[MonitoredSubscriptionsClientCreateorUpdateResponse], error)`
    info	[Changelog] - New function `*MonitoredSubscriptionsClient.BeginDelete(context.Context, string, string, ConfigurationName, *MonitoredSubscriptionsClientBeginDeleteOptions) (*runtime.Poller[MonitoredSubscriptionsClientDeleteResponse], error)`
    info	[Changelog] - New function `*MonitoredSubscriptionsClient.Get(context.Context, string, string, ConfigurationName, *MonitoredSubscriptionsClientGetOptions) (MonitoredSubscriptionsClientGetResponse, error)`
    info	[Changelog] - New function `*MonitoredSubscriptionsClient.NewListPager(string, string, *MonitoredSubscriptionsClientListOptions) *runtime.Pager[MonitoredSubscriptionsClientListResponse]`
    info	[Changelog] - New function `*MonitoredSubscriptionsClient.BeginUpdate(context.Context, string, string, ConfigurationName, MonitoredSubscriptionProperties, *MonitoredSubscriptionsClientBeginUpdateOptions) (*runtime.Poller[MonitoredSubscriptionsClientUpdateResponse], error)`
    info	[Changelog] - New function `*MonitorsClient.NewListLinkedResourcesPager(string, string, *MonitorsClientListLinkedResourcesOptions) *runtime.Pager[MonitorsClientListLinkedResourcesResponse]`
    info	[Changelog] - New struct `BillingInfoResponse`
    info	[Changelog] - New struct `ConnectedPartnerResourceProperties`
    info	[Changelog] - New struct `ConnectedPartnerResourcesListFormat`
    info	[Changelog] - New struct `ConnectedPartnerResourcesListResponse`
    info	[Changelog] - New struct `LinkedResource`
    info	[Changelog] - New struct `LinkedResourceListResponse`
    info	[Changelog] - New struct `MarketplaceSaaSInfo`
    info	[Changelog] - New struct `MonitoredSubscription`
    info	[Changelog] - New struct `MonitoredSubscriptionProperties`
    info	[Changelog] - New struct `MonitoredSubscriptionPropertiesList`
    info	[Changelog] - New struct `PartnerBillingEntity`
    info	[Changelog] - New struct `SubscriptionList`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 51 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from ff50e7f9e7261cc2e20734aa583a7abd318c5a02. 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-newrelicobservability [View full logs]  [Preview SDK Changes]
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added operation group BillingInfo
    info	[Changelog]   - Added operation group ConnectedPartnerResources
    info	[Changelog]   - Added operation group MonitoredSubscriptions
    info	[Changelog]   - Added operation Monitors.listLinkedResources
    info	[Changelog]   - Added Interface BillingInfoGetOptionalParams
    info	[Changelog]   - Added Interface BillingInfoResponse
    info	[Changelog]   - Added Interface ConnectedPartnerResourceProperties
    info	[Changelog]   - Added Interface ConnectedPartnerResourcesListFormat
    info	[Changelog]   - Added Interface ConnectedPartnerResourcesListNextOptionalParams
    info	[Changelog]   - Added Interface ConnectedPartnerResourcesListOptionalParams
    info	[Changelog]   - Added Interface ConnectedPartnerResourcesListResponse
    info	[Changelog]   - Added Interface LinkedResource
    info	[Changelog]   - Added Interface LinkedResourceListResponse
    info	[Changelog]   - Added Interface MarketplaceSaaSInfo
    info	[Changelog]   - Added Interface MonitoredSubscription
    info	[Changelog]   - Added Interface MonitoredSubscriptionProperties
    info	[Changelog]   - Added Interface MonitoredSubscriptionPropertiesList
    info	[Changelog]   - Added Interface MonitoredSubscriptionsCreateorUpdateOptionalParams
    info	[Changelog]   - Added Interface MonitoredSubscriptionsDeleteHeaders
    info	[Changelog]   - Added Interface MonitoredSubscriptionsDeleteOptionalParams
    info	[Changelog]   - Added Interface MonitoredSubscriptionsGetOptionalParams
    info	[Changelog]   - Added Interface MonitoredSubscriptionsListNextOptionalParams
    info	[Changelog]   - Added Interface MonitoredSubscriptionsListOptionalParams
    info	[Changelog]   - Added Interface MonitoredSubscriptionsUpdateHeaders
    info	[Changelog]   - Added Interface MonitoredSubscriptionsUpdateOptionalParams
    info	[Changelog]   - Added Interface MonitoringTagRulesProperties
    info	[Changelog]   - Added Interface MonitorsListLinkedResourcesNextOptionalParams
    info	[Changelog]   - Added Interface MonitorsListLinkedResourcesOptionalParams
    info	[Changelog]   - Added Interface PartnerBillingEntity
    info	[Changelog]   - Added Interface SubscriptionList
    info	[Changelog]   - Added Type Alias BillingInfoGetResponse
    info	[Changelog]   - Added Type Alias ConfigurationName
    info	[Changelog]   - Added Type Alias ConnectedPartnerResourcesListNextResponse
    info	[Changelog]   - Added Type Alias ConnectedPartnerResourcesListOperationResponse
    info	[Changelog]   - Added Type Alias MonitoredSubscriptionsCreateorUpdateResponse
    info	[Changelog]   - Added Type Alias MonitoredSubscriptionsDeleteResponse
    info	[Changelog]   - Added Type Alias MonitoredSubscriptionsGetResponse
    info	[Changelog]   - Added Type Alias MonitoredSubscriptionsListNextResponse
    info	[Changelog]   - Added Type Alias MonitoredSubscriptionsListResponse
    info	[Changelog]   - Added Type Alias MonitoredSubscriptionsUpdateResponse
    info	[Changelog]   - Added Type Alias MonitorsListLinkedResourcesNextResponse
    info	[Changelog]   - Added Type Alias MonitorsListLinkedResourcesResponse
    info	[Changelog]   - Added Type Alias PatchOperation
    info	[Changelog]   - Added Type Alias Status
    info	[Changelog]   - Added Enum KnownConfigurationName
    info	[Changelog]   - Added Enum KnownPatchOperation
    info	[Changelog]   - Added Enum KnownStatus
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Nov 2, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/newrelic/armnewrelicobservability https://apiview.dev/Assemblies/Review/fb8b4e7a51bb49479587cfd7bc4a30a4
Java azure-resourcemanager-newrelicobservability https://apiview.dev/Assemblies/Review/19f3a38567f3497e96c82a5c09c6cc4e
JavaScript @azure/arm-newrelicobservability https://apiview.dev/Assemblies/Review/04f23c15ace643e89b12dd4c19643937
Swagger NewRelic.Observability https://apiview.dev/Assemblies/Review/8b863d8a4f3b488cac49593233531b8d

@openapi-workflow-bot
Copy link
Copy Markdown

Hi @vipray-ms! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

@AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Nov 6, 2023
@AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Nov 6, 2023
@vipray-ms vipray-ms marked this pull request as ready for review November 6, 2023 08:23
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 6, 2023
@vipray-ms
Copy link
Copy Markdown
Member Author

    }

Add x-ms-pageable for list operation?

Refers to: specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json:1358 in 2fbda61. [](commit_id = 2fbda61, deletion_comment = False)

@zizw123
fixed, please check.

@mnasnh1009
Copy link
Copy Markdown

    "summary": "List the subscriptions currently being monitored by the NewRelic monitor resource.",

The URI path suggests that this operation gets the monitored subscriptions on a monitor by configuration. If that's the case, could you please update the summary?


Refers to: specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json:1377 in 085c053. [](commit_id = 085c053, deletion_comment = False)

@mnasnh1009
Copy link
Copy Markdown

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": {

From the path parameter description, it appears that the configuration of the monitored subscription is a singleton resource. Only default is supported. Would recommend adopting the best practices for modelling singleton resource. There are two ways:

  1. Define an enum for uri pparam:

{
"description": "The configuration name. Only 'default' value is supported.",
"in": "path",
"name": "configurationName",
"pattern": "^.*$",
"required": true,
"type": "string",
"enum": [
"Default"
],
"x-ms-enum": {
"name": "ConfigurationName",
"modelAsString": true
}
}
2. Static value in the uri path. For e.g: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions/default"


Refers to: specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json:1372 in 085c053. [](commit_id = 085c053, deletion_comment = False)

@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 Nov 13, 2023
@vipray-ms
Copy link
Copy Markdown
Member Author

    "summary": "List the subscriptions currently being monitored by the NewRelic monitor resource.",

The URI path suggests that this operation gets the monitored subscriptions on a monitor by configuration. If that's the case, could you please update the summary?

Refers to: specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json:1377 in 085c053. [](commit_id = 085c053, deletion_comment = False)

Current summary is correct, the resource via which this API would get call, this API will return the list of subscriptions monitored by that resource.

@vipray-ms
Copy link
Copy Markdown
Member Author

"enum": [
"Default"
],
"x-ms-enum": {
"name": "ConfigurationName",
"modelAsString": true
}

Done, Please check. Thanks.

@vipray-ms vipray-ms added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested labels Nov 13, 2023
@mnasnh1009 mnasnh1009 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 17, 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 Nov 17, 2023
Comment thread specification/newrelic/resource-manager/readme.md Outdated
@raych1 raych1 added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Nov 20, 2023
@vipray-ms
Copy link
Copy Markdown
Member Author

/pr RequestMerge

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

Labels

Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review Cadl Authored with Cadl CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-MissingBaseCommit IDCDevDiv Liftr Marketplace-Liftr RPs new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants