[VideoTranslation]Rename operation ID for translation/iteration creat…

…ion API due to we don't support replace in the API. (#30575) * Rename operation ID for translation/iteration creation API due to we don't support replace in API. * Supress operation ID change warning. * Supress typespec validation warning by PR validation.
Azure · Sep 18, 2024 · c08ac98 · c08ac98
1 parent 241ece1
commit c08ac98
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 10 deletions.
diff --git a/...nOperations_CreateOrReplaceIteration.json → .../IterationOperations_CreateIteration.json b/...nOperations_CreateOrReplaceIteration.json → .../IterationOperations_CreateIteration.json
@@ -1,6 +1,6 @@
 {
   "title": "Create Iteration",
-  "operationId": "IterationOperations_CreateOrReplaceIteration",
+  "operationId": "IterationOperations_CreateIteration",
   "parameters": {
     "Endpoint": "https://eastus.api.cognitive.microsoft.com/",
     "api-version": "2024-05-20-preview",

diff --git a/...perations_CreateOrReplaceTranslation.json → ...nslationOperations_CreateTranslation.json b/...perations_CreateOrReplaceTranslation.json → ...nslationOperations_CreateTranslation.json
@@ -1,6 +1,6 @@
 {
   "title": "Create Translation",
-  "operationId": "TranslationOperations_CreateOrReplaceTranslation",
+  "operationId": "TranslationOperations_CreateTranslation",
   "parameters": {
     "Endpoint": "https://eastus.api.cognitive.microsoft.com/",
     "api-version": "2024-05-20-preview",

diff --git a/specification/cognitiveservices/Speech.VideoTranslation/main.tsp b/specification/cognitiveservices/Speech.VideoTranslation/main.tsp
@@ -171,7 +171,7 @@ model IterationResult {
 
 @doc("Iteration input.")
 model IterationInput {
-  @doc("Webvtt file for content editing.")
+  @doc("Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation.")
   webvttFile?: WebvttFile;
 
   @doc("Number of speakers in the video.")
@@ -276,6 +276,9 @@ model Operation {
 
 interface TranslationOperations {
   // LongRunningResourceCreateOrReplace will generate PUT, to align with CNV other creation operation.
+  #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Because auto generated operation ID contains OrReplace(TranslationOperations_CreateOrReplaceTranslation), which will cause the operation title of the API doc's to be [Translation Operations - Create Or Replace Translation], because we don't support replace, specify the operation ID explicitly to avoid the misunderstanding API description."
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "The same as @azure-tools/typespec-azure-core/no-operation-id, no-operation-id is warning by tsp compile while no-openapi is validation by PR TypeSpec Validation pipeline."
+  @TypeSpec.OpenAPI.operationId("TranslationOperations_CreateTranslation")
   @doc("Creates a translation.")
   @pollingOperation(OperationOperations.getOperation)
   createOrReplaceTranslation is ops.LongRunningResourceCreateOrReplace<
@@ -298,6 +301,9 @@ interface TranslationOperations {
 
 interface IterationOperations {
   // LongRunningResourceCreateOrReplace will generate PUT, to align with CNV other creation operation.
+  #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Because auto generated operation ID contains OrReplace(IterationOperations_CreateOrReplaceIteration), which will cause the operation title of the API doc's to be [Iteration Operations - Create Or Replace Iteration], because we don't support replace, specify the operation ID explicitly to avoid the misunderstanding API description."
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "The same as @azure-tools/typespec-azure-core/no-operation-id, no-operation-id is warning by tsp compile while no-openapi is validation by PR TypeSpec Validation pipeline."
+  @TypeSpec.OpenAPI.operationId("IterationOperations_CreateIteration")
   @doc("Creates an iteration.")
   @pollingOperation(OperationOperations.getOperation)
   createOrReplaceIteration is ops.LongRunningResourceCreateOrReplace<

diff --git a/...vices/data-plane/Speech/VideoTranslation/preview/2024-05-20-preview/VideoTranslation.json b/...vices/data-plane/Speech/VideoTranslation/preview/2024-05-20-preview/VideoTranslation.json
@@ -221,7 +221,7 @@
         }
       },
       "put": {
-        "operationId": "TranslationOperations_CreateOrReplaceTranslation",
+        "operationId": "TranslationOperations_CreateTranslation",
         "tags": [
           "VideoTranslation"
         ],
@@ -295,7 +295,7 @@
         },
         "x-ms-examples": {
           "Create Translation": {
-            "$ref": "./examples/TranslationOperations_CreateOrReplaceTranslation.json"
+            "$ref": "./examples/TranslationOperations_CreateTranslation.json"
           }
         },
         "x-ms-long-running-operation-options": {
@@ -468,7 +468,7 @@
         }
       },
       "put": {
-        "operationId": "IterationOperations_CreateOrReplaceIteration",
+        "operationId": "IterationOperations_CreateIteration",
         "tags": [
           "VideoTranslation"
         ],
@@ -552,7 +552,7 @@
         },
         "x-ms-examples": {
           "Create Iteration": {
-            "$ref": "./examples/IterationOperations_CreateOrReplaceIteration.json"
+            "$ref": "./examples/IterationOperations_CreateIteration.json"
           }
         },
         "x-ms-long-running-operation-options": {
@@ -680,7 +680,7 @@
       "properties": {
         "webvttFile": {
           "$ref": "#/definitions/WebvttFile",
-          "description": "Webvtt file for content editing."
+          "description": "Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation."
         },
         "speakerCount": {
           "type": "integer",

diff --git a/...nOperations_CreateOrReplaceIteration.json → .../IterationOperations_CreateIteration.json b/...nOperations_CreateOrReplaceIteration.json → .../IterationOperations_CreateIteration.json
@@ -1,6 +1,6 @@
 {
   "title": "Create Iteration",
-  "operationId": "IterationOperations_CreateOrReplaceIteration",
+  "operationId": "IterationOperations_CreateIteration",
   "parameters": {
     "Endpoint": "https://eastus.api.cognitive.microsoft.com/",
     "api-version": "2024-05-20-preview",

diff --git a/...perations_CreateOrReplaceTranslation.json → ...nslationOperations_CreateTranslation.json b/...perations_CreateOrReplaceTranslation.json → ...nslationOperations_CreateTranslation.json
@@ -1,6 +1,6 @@
 {
   "title": "Create Translation",
-  "operationId": "TranslationOperations_CreateOrReplaceTranslation",
+  "operationId": "TranslationOperations_CreateTranslation",
   "parameters": {
     "Endpoint": "https://eastus.api.cognitive.microsoft.com/",
     "api-version": "2024-05-20-preview",