Generate container convenience APIs including paginated APIs (#624)

Author: christothes

api/OpenAI.net8.0.cs

@@ -33,7 +33,6 @@ protected override void Configure()
             AddVisitor(new OpenAILibraryVisitor());
             AddVisitor(new VirtualMessageCreationVisitor());
             AddVisitor(new ProhibitedNamespaceVisitor());
-            AddVisitor(new ExplicitConversionFromClientResultVisitor());
             AddVisitor(new ImplicitConversionToBinaryContentVisitor());
             AddVisitor(new ModelSerializationVisitor());
             AddVisitor(new ExperimentalAttributeVisitor());

api/OpenAI.netstandard2.0.cs

@@ -46,6 +46,22 @@ public class PaginationVisitor : ScmLibraryVisitor
             "GetChatCompletionMessagesAsync",
             ("ChatCompletionMessageListDatum", "ChatCompletionMessageCollectionOptions", _chatParamsToReplace)
         },
+        {
+            "GetContainers",
+            ("ContainerResource", "ContainerCollectionOptions", _chatParamsToReplace)
+        },
+        {
+            "GetContainersAsync",
+            ("ContainerResource", "ContainerCollectionOptions", _chatParamsToReplace)
+        },
+        {
+            "GetContainerFiles",
+            ("ContainerFileResource", "ContainerFileCollectionOptions", _chatParamsToReplace)
+        },
+        {
+            "GetContainerFilesAsync",
+            ("ContainerFileResource", "ContainerFileCollectionOptions", _chatParamsToReplace)
+        },
         {
             "GetInputItems",
             ("ResponseItem", "ResponseItemCollectionOptions", _chatParamsToReplace)

codegen/generator/src/OpenAILibraryGenerator.cs

@@ -13,13 +13,13 @@ model ContainerFileListResource {
   object: "list";
 
   /** A list of container files. */
-  data: ContainerFileResource[];
+  @pageItems data: ContainerFileResource[];
 
   /** The ID of the first file in the list. */
   first_id: string;
 
   /** The ID of the last file in the list. */
-  last_id: string;
+  @continuationToken last_id: string;
 
   /** Whether there are more files available. */
   has_more: boolean;
@@ -59,13 +59,13 @@ model ContainerListResource {
   object: "list";
 
   /** A list of containers. */
-  data: ContainerResource[];
+  @pageItems data: ContainerResource[];
 
   /** The ID of the first container in the list. */
   first_id: string;
 
   /** The ID of the last container in the list. */
-  last_id: string;
+  @continuationToken last_id: string;
 
   /** Whether there are more containers available. */
   has_more: boolean;

codegen/generator/src/Visitors/ExplicitConversionFromClientResultVisitor.cs

@@ -14,6 +14,7 @@ namespace OpenAI;
 interface Containers {
   @get
   @operationId("ListContainers")
+  @list
   listContainers(
     ...PageLimitQueryParameter,
     ...PageOrderQueryParameter,
@@ -64,6 +65,7 @@ interface Containers {
   @get
   @route("{container_id}/files")
   @operationId("ListContainerFiles")
+  @list
   listContainerFiles(
     @path
     container_id: string,

codegen/generator/src/Visitors/PaginationVisitor.cs

@@ -4,16 +4,6 @@ import "@azure-tools/typespec-client-generator-core";
 using OpenAI;
 using Azure.ClientGenerator.Core;
 
-@@convenientAPI(Containers.listContainers, false);
-@@convenientAPI(Containers.createContainer, false);
-@@convenientAPI(Containers.retrieveContainer, false);
-@@convenientAPI(Containers.deleteContainer, false);
-@@convenientAPI(Containers.createContainerFile, false);
-@@convenientAPI(Containers.listContainerFiles, false);
-@@convenientAPI(Containers.retrieveContainerFile, false);
-@@convenientAPI(Containers.deleteContainerFile, false);
-@@convenientAPI(Containers.retrieveContainerFileContent, false);
-
 @@clientName(Containers.retrieveContainer, "GetContainer");
 @@clientName(Containers.retrieveContainerFile, "GetContainerFile");
 @@clientName(Containers.retrieveContainerFileContent, "GetContainerFileContent");

specification/base/typespec/containers/models.tsp

@@ -0,0 +1,51 @@
+import "../../base/typespec/containers/main.tsp";
+import "@azure-tools/typespec-client-generator-core";
+
+using Azure.ClientGenerator.Core;
+using TypeSpec.Http;
+
+namespace OpenAI;
+
+alias ContainerCollectionOrderQueryParameter = {
+  /**
+   * Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
+   * for descending order.
+   */
+  @query order?: ContainerCollectionOrder;
+};
+
+union ContainerCollectionOrder {
+  string,
+  Ascending: "asc",
+  Descending: "desc",
+}
+
+@access(Access.public)
+@usage(Usage.input)
+model ContainerCollectionOptions {
+  ...CollectionAfterQueryParameter,
+  ...CollectionLimitQueryParameter,
+  ...ContainerCollectionOrderQueryParameter,
+}
+
+alias ContainerFileCollectionOrderQueryParameter = {
+  /**
+   * Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
+   * for descending order.
+   */
+  @query order?: ContainerCollectionOrder;
+};
+
+union ContainerFileCollectionOrder {
+  string,
+  Ascending: "asc",
+  Descending: "desc",
+}
+
+@access(Access.public)
+@usage(Usage.input)
+model ContainerFileCollectionOptions {
+  ...CollectionAfterQueryParameter,
+  ...CollectionLimitQueryParameter,
+  ...ContainerFileCollectionOrderQueryParameter,
+}

specification/base/typespec/containers/operations.tsp

@@ -16,6 +16,7 @@ import "./client/vector-stores.client.tsp";
 
 import "./client/models/audio.models.tsp";
 import "./client/models/chat.models.tsp";
+import "./client/models/container.models.tsp";
 import "./client/models/common.models.tsp";
 import "./client/models/responses.models.tsp";
 import "./client/models/vector-stores.models.tsp";