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

Fix operationIds in RP education #18846

Merged

Conversation

ArcturusZhang
Copy link
Member

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 language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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

ARM API Review Checklist

Applicability: ⚠️

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

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

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

  • Check this box if any of the following 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-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 28, 2022

Swagger Validation Report

️❌BreakingChange: 18 Errors, 0 Warnings failed [Detail]
Rule Message
1008 - ModifiedOperationId The operation id has been changed from 'Grants_List' to 'Grants_ListAll'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L53:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L53:7
1008 - ModifiedOperationId The operation id has been changed from 'Grant_List' to 'Grants_List'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L95:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L95:7
1008 - ModifiedOperationId The operation id has been changed from 'Get_Grant' to 'Grants_Get'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L143:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L143:7
1008 - ModifiedOperationId The operation id has been changed from 'Labs_List' to 'Labs_ListAll'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L188:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L188:7
1008 - ModifiedOperationId The operation id has been changed from 'Lab_List' to 'Labs_List'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L239:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L239:7
1008 - ModifiedOperationId The operation id has been changed from 'Get_Lab' to 'Labs_Get'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L290:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L290:7
1008 - ModifiedOperationId The operation id has been changed from 'Delete_Lab' to 'Labs_Delete'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L336:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L336:7
1008 - ModifiedOperationId The operation id has been changed from 'Create_Lab' to 'Labs_CreateOrUpdate'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L376:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L376:7
1008 - ModifiedOperationId The operation id has been changed from 'Generate_InviteCode' to 'Labs_GenerateInviteCode'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L433:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L433:7
1008 - ModifiedOperationId The operation id has been changed from 'JoinRequest_Get' to 'JoinRequests_Get'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L535:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L535:7
1008 - ModifiedOperationId The operation id has been changed from 'Approve_Invite' to 'JoinRequests_Approve'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L580:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L580:7
1008 - ModifiedOperationId The operation id has been changed from 'Deny_Invite' to 'JoinRequests_Deny'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L622:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L622:7
1008 - ModifiedOperationId The operation id has been changed from 'Redeem_Invite' to 'RedeemInvitationCode'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L664:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L664:7
1008 - ModifiedOperationId The operation id has been changed from 'Get_Student' to 'Students_Get'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L751:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L751:7
1008 - ModifiedOperationId The operation id has been changed from 'Delete_Student' to 'Students_Delete'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L794:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L794:7
1008 - ModifiedOperationId The operation id has been changed from 'Create_Student' to 'Students_CreateOrUpdate'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L837:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L837:7
1008 - ModifiedOperationId The operation id has been changed from 'StudentLabs_List' to 'StudentLabs_ListAll'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L897:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L897:7
1008 - ModifiedOperationId The operation id has been changed from 'Get_StudentLab' to 'StudentLabs_Get'. This will impact generated code.
New: Microsoft.Education/preview/2021-12-01-preview/education.json#L933:7
Old: Microsoft.Education/preview/2021-12-01-preview/education.json#L933:7
️⚠️LintDiff: 0 Warnings warning [Detail]
The following errors/warnings exist before current PR submission:
Rule Message
⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.Education/preview/2021-12-01-preview/education.json#L20
⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GrantList
Location: Microsoft.Education/preview/2021-12-01-preview/education.json#L99
⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GrantListIncludeAllocatedBudget
Location: Microsoft.Education/preview/2021-12-01-preview/education.json#L99
⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: CreateLab
Location: Microsoft.Education/preview/2021-12-01-preview/education.json#L437
⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: DeleteLab
Location: Microsoft.Education/preview/2021-12-01-preview/education.json#L798
⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Student
Location: Microsoft.Education/preview/2021-12-01-preview/education.json#L841
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[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-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 28, 2022

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-go-track2 - armeducation - 0.1.0
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-education - first release
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from fbc7948. 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]
    cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.5.5 -> 8.10.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.10.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.10.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-education [View full logs]  [Release SDK Changes]
    info	[Changelog]   - Initial Release
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from fbc7948. 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
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
    cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
    cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
    cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
    cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
  • ️✔️azure-resourcemanager-education [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from fbc7948. 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
  • ️✔️armeducation [View full logs]  [Release SDK Changes]
    info	[Changelog] This is a new package
    info	[Changelog]
️⚠️ azure-sdk-for-js warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from fbc7948. 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 read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
    cmderr	[automation_init.sh]  uuid@3.4.0: 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]  @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
    cmderr	[automation_init.sh]  deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
    cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 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-education [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 fbc7948. 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
    warn	No file changes detected after generation
  • ️✔️education [View full logs
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

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

@ghost
Copy link

ghost commented May 15, 2022

Hi, @ArcturusZhang. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants