Azure
api-version 2022-11-01 orbital
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [x] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- 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.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
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:
-
[x] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
-
[x] 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
Hi, @stuti-1807 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 89 Errors, 160 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| orbital.json | 2022-11-01(8100942) | 2022-03-01(main) |
| orbital.json | 2022-11-01(8100942) | 2021-04-04-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-11-01 | package-2022-11-01(8100942) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: ListInOperationName | Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L1017 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The resource name parameter 'spacecraftName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L156 |
|
The resource name parameter 'spacecraftName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L379 |
|
The resource name parameter 'spacecraftName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L427 |
|
The resource name parameter 'contactName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L427 |
|
The resource name parameter 'spacecraftName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L596 |
|
The resource name parameter 'contactProfileName' should be defined with a 'pattern' restriction. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L664 |
|
The get operation should only return 200. Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L1049 |
| :warning: LocationMustHaveXmsMutability | Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.Orbital/stable/2022-11-01/orbital.json#L1874 |
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Orbital/availableGroundStations/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/orbital/resource-manager/readme.md json: Microsoft.Orbital/stable/2022-03-01/orbital.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 4 Errors, 0 Warnings failed [Detail]
Tag package-2022-11-01; Prod region: Deployed
Test run on region: westus2; Operation coverage: total: 20, untested: 0, failed: 4, passed: 16
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: ARM resource, '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-reZPJq-22080/providers/Microsoft.Orbital/contactProfiles/contactp6dm3mt', does not exist. Please check your resource ID for typos. Correlation ID: 98b44718-71a1-463b-90e9-ebd6ddb88d8d Source: runtime OperationId: ContactProfiles_UpdateTags |
|
statusCode: 400, errorCode: BadContactWindow, errorMessage: No contacts available between spacecraft '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-reZPJq-22080/providers/Microsoft.Orbital/spacecrafts/spacecra1bz4xf' and ground station 'EASTUS2_0' during requested window (2023-02-22T10:58:30Z to 2023-02-22T11:10:45Z) because Contact reservation start time cannot be in the past.. Correlation ID: 5000540e-f01f-4d06-bae3-d1b3dbf31037 Source: runtime OperationId: Contacts_Create |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: ARM resource, '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-reZPJq-22080/providers/Microsoft.Orbital/spacecrafts/spacecra1bz4xf/contacts/contactnyst3nz', does not exist. Please check your resource ID for typos. Correlation ID: 554d4d30-2445-45b7-b4af-233bc879d744 Source: runtime OperationId: Contacts_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: ARM resource, '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/providers/Microsoft.Orbital/locations/westus2/operationResults/operatio7fqa5d', does not exist. Please check your resource ID for typos. Correlation ID: e78beb9b-5194-49a9-9a0b-88f850a30353 Source: runtime OperationId: OperationsResults_Get |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=349659&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/orbital/armorbital - Approved - 2.0.0+ Field `Etag` of struct `ContactProfile` has been removed + Field `Etag` of struct `Contact` has been removed + Field `Etag` of struct `Spacecraft` has been removed + Function `*AvailableGroundStationsClient.Get` has been removed + Struct `CloudErrorBody` has been removed + Struct `CloudError` has been removed + Type alias `APIVersionParameter` has been removed
❌azure-sdk-for-js - @azure/arm-orbital - Approved - 2.0.0+ Interface Contact no longer has parameter etag + Interface ContactProfile no longer has parameter etag + Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter links + Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter networkConfiguration + Interface Spacecraft no longer has parameter etag + Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter links + Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter titleLine + Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter tleLine1 + Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter tleLine2 + Operation ContactProfiles.beginCreateOrUpdate has a new signature + Operation ContactProfiles.beginCreateOrUpdateAndWait has a new signature + Operation Spacecrafts.beginCreateOrUpdate has a new signature + Operation Spacecrafts.beginCreateOrUpdateAndWait has a new signature + Parameter contactProfile of interface Contact is now required + Parameter expirationDate of interface AuthorizedGroundstation is now required + Parameter groundStation of interface AuthorizedGroundstation is now required + Parameter groundStationName of interface Contact is now required + Parameter id of interface ResourceReference is now required + Parameter links of interface ContactProfile is now required + Parameter links of interface Spacecraft is now required + Parameter networkConfiguration of interface ContactProfile is now required + Parameter reservationEndTime of interface Contact is now required + Parameter reservationStartTime of interface Contact is now required + Parameter titleLine of interface Spacecraft is now required + Parameter tleLine1 of interface Spacecraft is now required + Parameter tleLine2 of interface Spacecraft is now required + Removed Enum KnownApiVersionParameter + Removed operation AvailableGroundStations.get + Type of parameter status of interface Contact is changed from Status to ContactsStatus
❌azure-sdk-for-python-track2 - track2_azure-mgmt-orbital - Approved - 1.1.0b1+ Model Contact no longer has parameter etag + Model ContactProfile no longer has parameter etag + Model Spacecraft no longer has parameter etag + Parameter contact_profile of model Contact is now required + Parameter expiration_date of model AuthorizedGroundstation is now required + Parameter ground_station of model AuthorizedGroundstation is now required + Parameter ground_station_name of model Contact is now required + Parameter id of model AvailableContactsSpacecraft is now required + Parameter id of model ContactParametersContactProfile is now required + Parameter id of model ContactsPropertiesContactProfile is now required + Parameter id of model ResourceReference is now required + Parameter links of model ContactProfile is now required + Parameter links of model Spacecraft is now required + Parameter network_configuration of model ContactProfile is now required + Parameter reservation_end_time of model Contact is now required + Parameter reservation_start_time of model Contact is now required + Parameter title_line of model Spacecraft is now required + Parameter tle_line1 of model Spacecraft is now required + Parameter tle_line2 of model Spacecraft is now required + Removed operation AvailableGroundStationsOperations.get
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from f84a940c6fbb7815f2a19a8494f07c108253bca4. SDK Automation 14.0.0command 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.3.1 -> 9.5.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-orbital [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Model ContactProfile has a new parameter third_party_configurations info [Changelog] - Model ContactProfileProperties has a new parameter third_party_configurations info [Changelog] - Model ContactProfilesProperties has a new parameter third_party_configurations info [Changelog] - Model OperationResult has a new parameter next_link info [Changelog] - Model OperationResult has a new parameter value info [Changelog] - Operation ContactProfilesOperations.begin_create_or_update has a new optional parameter third_party_configurations info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Model Contact no longer has parameter etag info [Changelog] - Model ContactProfile no longer has parameter etag info [Changelog] - Model Spacecraft no longer has parameter etag info [Changelog] - Parameter contact_profile of model Contact is now required info [Changelog] - Parameter expiration_date of model AuthorizedGroundstation is now required info [Changelog] - Parameter ground_station of model AuthorizedGroundstation is now required info [Changelog] - Parameter ground_station_name of model Contact is now required info [Changelog] - Parameter id of model AvailableContactsSpacecraft is now required info [Changelog] - Parameter id of model ContactParametersContactProfile is now required info [Changelog] - Parameter id of model ContactsPropertiesContactProfile is now required info [Changelog] - Parameter id of model ResourceReference is now required info [Changelog] - Parameter links of model ContactProfile is now required info [Changelog] - Parameter links of model Spacecraft is now required info [Changelog] - Parameter network_configuration of model ContactProfile is now required info [Changelog] - Parameter reservation_end_time of model Contact is now required info [Changelog] - Parameter reservation_start_time of model Contact is now required info [Changelog] - Parameter title_line of model Spacecraft is now required info [Changelog] - Parameter tle_line1 of model Spacecraft is now required info [Changelog] - Parameter tle_line2 of model Spacecraft is now required info [Changelog] - Removed operation AvailableGroundStationsOperations.get
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from f84a940c6fbb7815f2a19a8494f07c108253bca4. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-orbital [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from f84a940c6fbb7815f2a19a8494f07c108253bca4. SDK Automation 14.0.0command 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/orbital/armorbital [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Type alias `APIVersionParameter` has been removed info [Changelog] - Function `*AvailableGroundStationsClient.Get` has been removed info [Changelog] - Struct `CloudError` has been removed info [Changelog] - Struct `CloudErrorBody` has been removed info [Changelog] - Field `Etag` of struct `Contact` has been removed info [Changelog] - Field `Etag` of struct `ContactProfile` has been removed info [Changelog] - Field `Etag` of struct `Spacecraft` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New struct `ContactProfileThirdPartyConfiguration` info [Changelog] - New struct `ErrorAdditionalInfo` info [Changelog] - New struct `ErrorDetail` info [Changelog] - New struct `ErrorResponse` info [Changelog] - New field `ThirdPartyConfigurations` in struct `ContactProfileProperties` info [Changelog] - New field `ThirdPartyConfigurations` in struct `ContactProfilesProperties` info [Changelog] - New field `NextLink` in struct `OperationResult` info [Changelog] - New field `Value` in struct `OperationResult` info [Changelog] info [Changelog] Total 9 breaking change(s), 11 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from f84a940c6fbb7815f2a19a8494f07c108253bca4. SDK Automation 14.0.0command 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-orbital [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added Interface ContactProfileThirdPartyConfiguration info [Changelog] - Added Interface ErrorAdditionalInfo info [Changelog] - Added Interface ErrorDetail info [Changelog] - Added Interface ErrorResponse info [Changelog] - Added Type Alias ContactsStatus info [Changelog] - Interface ContactProfile has a new optional parameter thirdPartyConfigurations info [Changelog] - Interface ContactProfilesCreateOrUpdateOptionalParams has a new optional parameter thirdPartyConfigurations info [Changelog] - Interface ContactProfilesProperties has a new optional parameter thirdPartyConfigurations info [Changelog] - Interface OperationResult has a new optional parameter nextLink info [Changelog] - Interface OperationResult has a new optional parameter value info [Changelog] - Added Enum KnownContactsStatus info [Changelog] - Added Enum KnownStatus info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Removed operation AvailableGroundStations.get info [Changelog] - Operation ContactProfiles.beginCreateOrUpdate has a new signature info [Changelog] - Operation ContactProfiles.beginCreateOrUpdateAndWait has a new signature info [Changelog] - Operation Spacecrafts.beginCreateOrUpdate has a new signature info [Changelog] - Operation Spacecrafts.beginCreateOrUpdateAndWait has a new signature info [Changelog] - Interface Contact no longer has parameter etag info [Changelog] - Interface ContactProfile no longer has parameter etag info [Changelog] - Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter links info [Changelog] - Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter networkConfiguration info [Changelog] - Interface Spacecraft no longer has parameter etag info [Changelog] - Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter links info [Changelog] - Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter titleLine info [Changelog] - Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter tleLine1 info [Changelog] - Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter tleLine2 info [Changelog] - Parameter expirationDate of interface AuthorizedGroundstation is now required info [Changelog] - Parameter groundStation of interface AuthorizedGroundstation is now required info [Changelog] - Parameter contactProfile of interface Contact is now required info [Changelog] - Parameter groundStationName of interface Contact is now required info [Changelog] - Parameter reservationEndTime of interface Contact is now required info [Changelog] - Parameter reservationStartTime of interface Contact is now required info [Changelog] - Parameter links of interface ContactProfile is now required info [Changelog] - Parameter networkConfiguration of interface ContactProfile is now required info [Changelog] - Parameter id of interface ResourceReference is now required info [Changelog] - Parameter links of interface Spacecraft is now required info [Changelog] - Parameter titleLine of interface Spacecraft is now required info [Changelog] - Parameter tleLine1 of interface Spacecraft is now required info [Changelog] - Parameter tleLine2 of interface Spacecraft is now required info [Changelog] - Type of parameter status of interface Contact is changed from Status to ContactsStatus info [Changelog] - Removed Enum KnownApiVersionParameter
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from f84a940c6fbb7815f2a19a8494f07c108253bca4. Schema Automation 14.0.0command .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
️✔️orbital [View full logs] [Release Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from f84a940c6fbb7815f2a19a8494f07c108253bca4. SDK Automation 14.0.0command 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
️✔️Az.Orbital [View full logs] [Release SDK Changes]
Hi, @stuti-1807 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/orbital/armorbital | https://apiview.dev/Assemblies/Review/0b25605b997941d094964eb674ccf36a |
| Java | azure-resourcemanager-orbital | https://apiview.dev/Assemblies/Review/7e729b57f56d438cac3fa2759cd6288f |
| JavaScript | @azure/arm-orbital | https://apiview.dev/Assemblies/Review/b740510bb75f4262a877b9768a96172c |
Hi @stuti-1807, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. 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. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
Hi, @stuti-1807, 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. Or you could onboard API spec pipeline
Hi @stuti-1807, 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.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
@stuti-1807 - Thank-you for updating the PR format: much appreciated. It looks like your PR is getting flagged for breaking change review due to making some properties required that were previously not required. I think this is considered breaking, since the old API version might not send those properties, but the new API version is expecting them. Next step is to follow the instructions in this comment: https://github.com/Azure/azure-rest-api-specs/pull/22080#issuecomment-1372781790.
Note: ARM review waits for the outcome of handling the breaking change review label. Once the breaking change label is addressed, apply the WaitForARMFeedback label again and the current oncall will start ARM review.
@xiaoxuqi-ms any idea what is up with the apiDocPreview task? I've seen it failing in a lot of recent PRs.
Adding back 'ArmChangesRequested' as I didn't see responses or fixes for all comments.
@xiaoxuqi-ms any idea what is up with the apiDocPreview task? I've seen it failing in a lot of recent PRs.
@ruowan could you help to take a look at the apiDocPreview failure?
@qiaozha , @tadelesh , @msyyc , could you help to review this pr for SDK breaking changes? Many thanks
@qiaozha I dig deep into these breakings and think they are introduced by this new stable version as expected so suggest we accept JS breaking.
@stuti-1807 please fix the linter errors introduced by latest commit and make sure the new version apis have been deployed to prod
@MaryGao I still see ADK azure-sdk-for-js check failing even after your approved tag. Can you please help us with this?
@stuti-1807 API Readiness Check is failing: "code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Orbital' for api version '2022-11-01'. The supported api-versions are '2021-04-04-preview, 2022-03-01'." Please refer to https://github.com/Azure/azure-rest-api-specs/pull/22080#issuecomment-1372762089 for more details.
Docs preview is failing as well:
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Operations-Results\Get.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contacts\List.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contact-Profiles\Update-Tags.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Spacecrafts\Update-Tags.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Operations\List.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Available-Ground-Stations\List-By-Capability.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contacts\Get.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Spacecrafts\List-By-Subscription.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contact-Profiles\List-By-Subscription.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contacts\Delete.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Spacecrafts\List-Available-Contacts.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contacts\Create.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Available-Ground-Stations\Get.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contact-Profiles\List.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Spacecrafts\List.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contact-Profiles\Delete.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Spacecrafts\Delete.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Spacecrafts\Get.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contact-Profiles\Get.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Spacecrafts\Create-Or-Update.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Exception occurs: Error generate yml files for D:\a\1\s\target_repo\structured\default\documentation-preview\Contact-Profiles\Create-Or-Update.json, details: System.ArgumentNullException: Value cannot be null. (Parameter 'metadata')
Seems like metadata is empty in related swagger files.
please make sure the new version has been deployed to prod to fix API readiness check
@xiaoxuqi-ms Can you please merge the PR? I don't have the authorization to merge it
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi @stuti-1807 if all comment has been addressed, then please reach out to Tim for approval. there is still one change requested to be confirmed.