use body root to specify which parameter models we want to keep group…

…ed (#29483) * add ops.ResourceCollectionAction KeepModel * add ops.ResourceAction KeepModel * add ops.LongRunningResourceAction KeepModel * other templates * switch over to BodyParameter * format * use valueof in BodyParameter template, add doc * remove unnecessary documentation * add doc to BodyParameter template * add extra specs * fix formatting of BodyParameter * format * format * format * suppress doc warning * move body parameter to template * add default body parameter doc * default bodyparam doc to body parameter * fix validation errors * remove bodyparameter from codetransparency * try for openai * remove incorrect alias bodyparameter * don't spread CreateLivenessWithVerifySessionContent * fix breaking change in easm * add readme to openai assistants * update readme * add tag to readme * fix json file reference * add json files to list --------- Co-authored-by: iscai-msft <isabellavcai@gmail.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
Azure · Jun 26, 2024 · c286401 · c286401
1 parent 2b6c728
commit c286401
Show file tree

Hide file tree

Showing 52 changed files with 1,656 additions and 1,032 deletions.
diff --git a/specification/ai/Face/models.common.tsp b/specification/ai/Face/models.common.tsp
@@ -294,3 +294,14 @@ model FaceError {
 }
 
 model FaceErrorResponse is Azure.Core.Foundations.ErrorResponseBase<FaceError>;
+
+alias BodyParameter<
+  T,
+  TName extends valueof string = "body",
+  TDoc extends valueof string = "Body parameter."
+> = {
+  @doc(TDoc)
+  @friendlyName(TName)
+  @bodyRoot
+  body: T;
+};
diff --git a/specification/ai/Face/routes.session.tsp b/specification/ai/Face/routes.session.tsp
@@ -69,7 +69,7 @@ interface LivenessSessionOperations {
   @returnsDoc(SessionCreationSuccess)
   createLivenessSession is FaceResourceCreateWithServiceProvidedName<
     LivenessSession,
-    CreateLivenessSessionContent,
+    BodyParameter<CreateLivenessSessionContent>,
     CreateLivenessSessionResult
   >;
 
@@ -118,7 +118,7 @@ interface LivenessSessionOperations {
   @sharedRoute
   createLivenessWithVerifySession is FaceResourceCreateWithServiceProvidedName<
     LivenessWithVerifySession,
-    CreateLivenessSessionContent,
+    BodyParameter<CreateLivenessSessionContent>,
     CreateLivenessWithVerifySessionResult
   >;
 

diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp
@@ -229,3 +229,14 @@ model ClinicalCodedElement {
   @doc("A value associated with the code within the given clinical coding system.")
   value?: string;
 }
+
+alias BodyParameter<
+  T,
+  TName extends valueof string = "body",
+  TDoc extends valueof string = "Body parameter."
+> = {
+  @doc(TDoc)
+  @friendlyName(TName)
+  @bodyRoot
+  body: T;
+};
diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp
@@ -19,7 +19,7 @@ interface OncoPhenotype {
   @doc("Gets the status and details of the Onco Phenotype job.")
   @get
   @route("/onco-phenotype/jobs/{id}")
-  getJob is HealthInsightsLongRunningPollOperation<OncoPhenotypeResult>;
+  getJob is HealthInsightsLongRunningPollOperation<BodyParameter<OncoPhenotypeResult>>;
 
   #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location"
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core"

diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp
@@ -19,7 +19,7 @@ interface PatientTimeline {
   @doc("Gets the status and details of the Patient Timeline job.")
   @get
   @route("/patient-timeline/jobs/{id}")
-  getJob is HealthInsightsLongRunningPollOperation<PatientTimelineResult>;
+  getJob is HealthInsightsLongRunningPollOperation<BodyParameter<PatientTimelineResult>>;
 
   #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location"
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core"

diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp
@@ -18,7 +18,7 @@ interface TrialMatcher {
   @doc("Gets the status and details of the Trial Matcher job.")
   @get
   @route("/trial-matcher/jobs/{id}")
-  getJob is HealthInsightsLongRunningPollOperation<TrialMatcherResult>;
+  getJob is HealthInsightsLongRunningPollOperation<BodyParameter<TrialMatcherResult>>;
 
   #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location"
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core"

diff --git a/specification/ai/OpenAI.Assistants/assistants/routes.tsp b/specification/ai/OpenAI.Assistants/assistants/routes.tsp
@@ -20,7 +20,7 @@ namespace Azure.AI.OpenAI.Assistants;
 @post
 @added(ServiceApiVersions.v2024_02_15_preview)
 @route("/assistants")
-op createAssistant(...AssistantCreationOptions): Assistant;
+op createAssistant(...BodyParameter<AssistantCreationOptions>): Assistant;
 
 /**
  * Gets a list of assistants that were previously created.
@@ -63,7 +63,7 @@ op getAssistant(@path assistantId: string): Assistant;
 @post
 @route("/assistants/{assistantId}")
 @added(ServiceApiVersions.v2024_02_15_preview)
-op updateAssistant(...UpdateAssistantOptions): Assistant;
+op updateAssistant(...BodyParameter<UpdateAssistantOptions>): Assistant;
 
 /**
  * Deletes an assistant.

diff --git a/specification/ai/OpenAI.Assistants/common/models.tsp b/specification/ai/OpenAI.Assistants/common/models.tsp
@@ -148,3 +148,14 @@ union ApiResponseFormat {
   /** Using `json_object` format will limit the usage of ToolCall to only functions. */
   jsonObject: "json_object",
 }
+
+alias BodyParameter<
+  T,
+  TName extends valueof string = "body",
+  TDoc extends valueof string = "Body parameter."
+> = {
+  @doc(TDoc)
+  @friendlyName(TName)
+  @bodyRoot
+  body: T;
+};
diff --git a/specification/ai/OpenAI.Assistants/runs/routes.tsp b/specification/ai/OpenAI.Assistants/runs/routes.tsp
@@ -139,4 +139,4 @@ op cancelRun(@path threadId: string, @path runId: string): ThreadRun;
 @route("/threads/runs")
 @doc("Creates a new assistant thread and immediately starts a run using that new thread.")
 @added(ServiceApiVersions.v2024_02_15_preview)
-op createThreadAndRun(...CreateAndRunThreadOptions): ThreadRun;
+op createThreadAndRun(...BodyParameter<CreateAndRunThreadOptions>): ThreadRun;
diff --git a/specification/ai/OpenAI.Assistants/threads/routes.tsp b/specification/ai/OpenAI.Assistants/threads/routes.tsp
@@ -20,7 +20,9 @@ namespace Azure.AI.OpenAI.Assistants;
 @post
 @added(ServiceApiVersions.v2024_02_15_preview)
 @route("/threads")
-op createThread(...AssistantThreadCreationOptions): AssistantThread;
+op createThread(
+  ...BodyParameter<AssistantThreadCreationOptions>,
+): AssistantThread;
 
 // list threads?
 
@@ -52,7 +54,9 @@ op getThread(@path threadId: string): AssistantThread;
 @post
 @route("/threads/{threadId}")
 @added(ServiceApiVersions.v2024_02_15_preview)
-op updateThread(...UpdateAssistantThreadOptions): AssistantThread;
+op updateThread(
+  ...BodyParameter<UpdateAssistantThreadOptions>,
+): AssistantThread;
 
 /**
  * Deletes an existing thread.

diff --git a/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp
@@ -34,7 +34,7 @@ op listVectorStores(
 @post
 @route("/vector_stores")
 @added(ServiceApiVersions.v2024_05_01_preview)
-op createVectorStore(...VectorStoreOptions): VectorStore;
+op createVectorStore(...BodyParameter<VectorStoreOptions>): VectorStore;
 
 /**
  * Returns the vector store object matching the specified ID.

diff --git a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json
@@ -408,6 +408,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/CreateLivenessSessionContent"
@@ -5846,6 +5847,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/CreateLivenessSessionContent"

diff --git a/...ta-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/...ta-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json
@@ -174,6 +174,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AssistantCreationOptions"
@@ -217,11 +218,16 @@
         "description": "Modifies an existing assistant.",
         "parameters": [
           {
-            "$ref": "#/parameters/UpdateAssistantOptions.assistantId"
+            "name": "assistantId",
+            "in": "path",
+            "description": "The ID of the assistant to modify.",
+            "required": true,
+            "type": "string"
           },
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/UpdateAssistantOptions"
@@ -460,6 +466,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AssistantThreadCreationOptions"
@@ -503,11 +510,16 @@
         "description": "Modifies an existing thread.",
         "parameters": [
           {
-            "$ref": "#/parameters/UpdateAssistantThreadOptions.threadId"
+            "name": "threadId",
+            "in": "path",
+            "description": "The ID of the thread to modify.",
+            "required": true,
+            "type": "string"
           },
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/UpdateAssistantThreadOptions"
@@ -1235,6 +1247,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/CreateAndRunThreadOptions"
@@ -3181,22 +3194,5 @@
       }
     }
   },
-  "parameters": {
-    "UpdateAssistantOptions.assistantId": {
-      "name": "assistantId",
-      "in": "path",
-      "description": "The ID of the assistant to modify.",
-      "required": true,
-      "type": "string",
-      "x-ms-parameter-location": "method"
-    },
-    "UpdateAssistantThreadOptions.threadId": {
-      "name": "threadId",
-      "in": "path",
-      "description": "The ID of the thread to modify.",
-      "required": true,
-      "type": "string",
-      "x-ms-parameter-location": "method"
-    }
-  }
+  "parameters": {}
 }
diff --git a/...ta-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/...ta-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json
@@ -174,6 +174,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AssistantCreationOptions"
@@ -217,11 +218,16 @@
         "description": "Modifies an existing assistant.",
         "parameters": [
           {
-            "$ref": "#/parameters/UpdateAssistantOptions.assistantId"
+            "name": "assistantId",
+            "in": "path",
+            "description": "The ID of the assistant to modify.",
+            "required": true,
+            "type": "string"
           },
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/UpdateAssistantOptions"
@@ -496,6 +502,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AssistantThreadCreationOptions"
@@ -539,11 +546,16 @@
         "description": "Modifies an existing thread.",
         "parameters": [
           {
-            "$ref": "#/parameters/UpdateAssistantThreadOptions.threadId"
+            "name": "threadId",
+            "in": "path",
+            "description": "The ID of the thread to modify.",
+            "required": true,
+            "type": "string"
           },
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/UpdateAssistantThreadOptions"
@@ -1287,6 +1299,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/CreateAndRunThreadOptions"
@@ -1418,6 +1431,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "Body parameter.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/VectorStoreOptions"
@@ -5172,22 +5186,5 @@
       }
     }
   },
-  "parameters": {
-    "UpdateAssistantOptions.assistantId": {
-      "name": "assistantId",
-      "in": "path",
-      "description": "The ID of the assistant to modify.",
-      "required": true,
-      "type": "string",
-      "x-ms-parameter-location": "method"
-    },
-    "UpdateAssistantThreadOptions.threadId": {
-      "name": "threadId",
-      "in": "path",
-      "description": "The ID of the thread to modify.",
-      "required": true,
-      "type": "string",
-      "x-ms-parameter-location": "method"
-    }
-  }
+  "parameters": {}
 }