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

feat(apim): Add ability to create and update new OData api #23849

Conversation

quanterion
Copy link
Contributor

@quanterion quanterion commented May 7, 2023

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.

Add ability to create and update new OData api

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. 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):

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 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.
  • 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.

@quanterion quanterion requested a review from solankisamir as a code owner May 7, 2023 20:11
@openapi-workflow-bot
Copy link

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

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

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 7, 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
    apimapis.json 2023-03-01-preview(79b98a8) 2022-08-01(main)
    apimapis.json 2023-03-01-preview(79b98a8) 2022-09-01-preview(main)
    definitions.json 2023-03-01-preview(79b98a8) 2022-08-01(main)
    definitions.json 2023-03-01-preview(79b98a8) 2022-09-01-preview(main)
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.1) new version base version
    package-preview-2023-03 package-preview-2023-03(79b98a8) package-preview-2023-03(release-Microsoft.ApiManagement-2023-03-01-preview)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L96
    ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L215
    ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L215
    PutRequestResponseSchemeArm A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Api_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema'
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L215
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L340
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L509
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L571
    RepeatedPathInfo The 'apiId' already appears in the path, please don't repeat it in the request body.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L708
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L790
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L790
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1279
    ParametersInPointGet Query parameter format should be removed. Point Get's MUST not have query parameters other than api version.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1356
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1583
    PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1742
    PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1742
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1858
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2202
    ParametersInPointGet Query parameter format should be removed. Point Get's MUST not have query parameters other than api version.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2282
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2506
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2555
    ParametersInPointGet Query parameter format should be removed. Point Get's MUST not have query parameters other than api version.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2634
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2852
    ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2970
    ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2970
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3050
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3161
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3380
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3380
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3522
    ParametersInPointGet Query parameter expandCommentsAttachments should be removed. Point Get's MUST not have query parameters other than api version.
    Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3600
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 7, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-python-track2 warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-resource-manager-schemas warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-powershell failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 7, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.ApiManagement https://apiview.dev/Assemblies/Review/c1a1d701422e454a93fae3b3bfc59959
    Go sdk/resourcemanager/apimanagement/armapimanagement https://apiview.dev/Assemblies/Review/b0e0b4a3eb5b416a8c56f4a7e05b7c2f
    JavaScript @azure/arm-apimanagement https://apiview.dev/Assemblies/Review/fae94eb7c38a4178a2c8bacc96e8abb5

    @openapi-workflow-bot
    Copy link

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

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

    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot
    Copy link

    Hi @quanterion This PR was flagged for attempting to introduce a new RP namespace to the main branch without first merging the new RP to the RPSaaSMaster branch. Please add the new RP in a merge to RPSaaSMaster before continuing the merge to main.

    @openapi-workflow-bot
    Copy link

    Hi, @quanterion, 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

    @TimLovellSmith TimLovellSmith added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 12, 2023
    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 12, 2023
    @quanterion
    Copy link
    Contributor Author

    @TimLovellSmith Addressed comments, please take a look

    @solankisamir solankisamir removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 14, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 14, 2023
    @raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 15, 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 May 15, 2023
    @solankisamir
    Copy link
    Member

    @zedy-wj please merge when ready.

    @solankisamir
    Copy link
    Member

    @zedy-wj please merge when ready. Thanks again!

    @zedy-wj zedy-wj added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 18, 2023
    @live1206 live1206 merged commit 54cc2bf into Azure:release-Microsoft.ApiManagement-2023-03-01-preview May 18, 2023
    live1206 pushed a commit that referenced this pull request Jun 25, 2023
    * Adds base for updating Microsoft.ApiManagement from version preview/2022-09-01-preview to version 2023-03-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * feat(apim): Provide capability to use custom hostname for Configuration API v2 (#23785)
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * feat(rp): Added flags to enable/disable portals (#23799)
    
    * feat(rp): Added flags to enable/disable portals
    
    * update default
    
    * feat(apim): Provide capability to disable legacy configuration API  (#23786)
    
    * feat(apim): Provide capability to disable legacy configuration API
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * Update sample
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * Fix type definition
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * Switch to enum
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * Update samples
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    ---------
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * feat(apim): Add new tracing API (#23800)
    
    * Add new tracing api
    
    * Remove TODOs descriptions
    
    * Improve descriptions
    
    * Fix dot
    
    * Add missing examples
    
    * prettier fixes
    
    * Fix model and semantic problems
    
    * Remove get prefix in post operations
    
    * Use list prefix
    
    * Fix PR comments
    
    * feat(apim): Add ability to create and update new OData api (#23849)
    
    * Add odata api definitions
    
    * add api usage example
    
    * fix file reference
    
    * address comments
    
    ---------
    
    Co-authored-by: rkolesnikov <rkolesnikov@microsoft.com>
    
    * migration contract (#23983)
    
    * 2023 03 cred scan fix - Examples Only (#24357)
    
    * remove-sas-signature
    
    * update example
    
    * 2023-03-01-preview arm review feedback (#24404)
    
    * move to v5 subscription contract
    
    * move to v5 for rg and api-version
    
    * cred scan
    
    * default is true
    
    * uuid in examples
    
    * change from boolean to enums
    
    * fix default value
    
    ---------
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    Co-authored-by: Harun Reşit <harun5hy@outlook.com>
    Co-authored-by: Rafał Mielowski <rmielowski@microsoft.com>
    Co-authored-by: Roman Kolesnikov <Rem.Kolomna@gmail.com>
    Co-authored-by: rkolesnikov <rkolesnikov@microsoft.com>
    harryli0108 pushed a commit to harryli0108/azure-rest-api-specs that referenced this pull request Jul 28, 2023
    * Adds base for updating Microsoft.ApiManagement from version preview/2022-09-01-preview to version 2023-03-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * feat(apim): Provide capability to use custom hostname for Configuration API v2 (Azure#23785)
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * feat(rp): Added flags to enable/disable portals (Azure#23799)
    
    * feat(rp): Added flags to enable/disable portals
    
    * update default
    
    * feat(apim): Provide capability to disable legacy configuration API  (Azure#23786)
    
    * feat(apim): Provide capability to disable legacy configuration API
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * Update sample
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * Fix type definition
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * Switch to enum
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * Update samples
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    ---------
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    
    * feat(apim): Add new tracing API (Azure#23800)
    
    * Add new tracing api
    
    * Remove TODOs descriptions
    
    * Improve descriptions
    
    * Fix dot
    
    * Add missing examples
    
    * prettier fixes
    
    * Fix model and semantic problems
    
    * Remove get prefix in post operations
    
    * Use list prefix
    
    * Fix PR comments
    
    * feat(apim): Add ability to create and update new OData api (Azure#23849)
    
    * Add odata api definitions
    
    * add api usage example
    
    * fix file reference
    
    * address comments
    
    ---------
    
    Co-authored-by: rkolesnikov <rkolesnikov@microsoft.com>
    
    * migration contract (Azure#23983)
    
    * 2023 03 cred scan fix - Examples Only (Azure#24357)
    
    * remove-sas-signature
    
    * update example
    
    * 2023-03-01-preview arm review feedback (Azure#24404)
    
    * move to v5 subscription contract
    
    * move to v5 for rg and api-version
    
    * cred scan
    
    * default is true
    
    * uuid in examples
    
    * change from boolean to enums
    
    * fix default value
    
    ---------
    
    Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
    Co-authored-by: Harun Reşit <harun5hy@outlook.com>
    Co-authored-by: Rafał Mielowski <rmielowski@microsoft.com>
    Co-authored-by: Roman Kolesnikov <Rem.Kolomna@gmail.com>
    Co-authored-by: rkolesnikov <rkolesnikov@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    2023-03-01-preview APIM 2023-03-01-preview PRs API Management Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-FixRequiredOnFailure resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    8 participants