Skip to content

Create a stable API version for Video Indexer with private endpoints #33501

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

yaeldMS
Copy link
Contributor

@yaeldMS yaeldMS commented Mar 26, 2025

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

Click here to open a PR for only SDK configuration.

Copy link

openapi-pipeline-app bot commented Mar 26, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    Automation should then add WaitForARMFeedback label.
    ❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ The required check named SDK azure-sdk-for-go has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 3 in the PR workflow diagram

Copy link

openapi-pipeline-app bot commented Mar 26, 2025

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

@github-actions github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Mar 26, 2025
@azure-sdk
Copy link
Collaborator

azure-sdk commented Mar 26, 2025

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
Swagger Microsoft.VideoIndexer
Java com.azure.resourcemanager:azure-resourcemanager-vi

@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version NotReadyForARMReview and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 26, 2025
@JeffreyRichter JeffreyRichter added the BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior label Apr 2, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Apr 6, 2025
@dazilb
Copy link
Member

dazilb commented Apr 6, 2025

@JeffreyRichter Can you please add the required labels to the PR? for some reason we are unable to do that.
Additionally, we have some failing validation, however the validations are failing for things that we did not modify in this PR, can you make an exception for these validations?

@mikeharder
Copy link
Member

LintDiff error is because your spec has multiple different definitions of the same enum:

        "scope": {
          "type": "string",
          "description": "The requested media type",
          "enum": [
            "Video",
            "Account",
            "Project"
          ],
          "x-ms-enum": {
            "name": "scope",
            "modelAsString": true
          }
        },
        
        "scope": {
          "type": "string",
          "description": "The requested media type",
          "enum": [
            "Video",
            "Account"
          ],
          "x-ms-enum": {
            "name": "scope",
            "modelAsString": true
          }
        },

@yaeldMS
Copy link
Contributor Author

yaeldMS commented Apr 8, 2025

Thanks @mikeharder. Can you help me understand how to fix it? These definitions are not part of my change (in the first iteration of the PR I copied the previous version without any changes).


In reply to: 2785483382

@mikeharder
Copy link
Member

mikeharder commented Apr 8, 2025

Can you help me understand how to fix it?

per the doc linked from the error, fix is to align the enum values, or rename one of the enums.

These definitions are not part of my change (in the first iteration of the PR I copied the previous version without any changes).

Actually, they are part of your change. The error was introduced in your swagger in #32732, but this PR failed to update readme.md, which means the error is only being detected now.

@razvanbadea-msft
Copy link
Member

Choose a PR Template description and add a description to this pr to have the Purpose of PR and due diligence sections added

@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Apr 8, 2025
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 8, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Apr 9, 2025
@yaeldMS
Copy link
Contributor Author

yaeldMS commented Apr 9, 2025

@razvanbadea-msft, I tried clicking on the control plane option but nothing happened. Can you help me with this?


In reply to: 2786608674

@yaeldMS
Copy link
Contributor Author

yaeldMS commented Apr 21, 2025

Hi @razvanbadea-msft , I created a new PR for this change: #34075 because Tal and Raz are currently not available to approve, and it says that merging is blocked because it needs reapproval from Tal. Could you please help with merging it? Thanks.

Copy link
Contributor

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

@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label May 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. new-api-version no-recent-activity There has been no recent activity on this issue. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS SuppressionReviewRequired
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants