Add CONTRIBUTING guide, fix Add-Customizations.ps1 script (#4)

annelo-msft · Feb 29, 2024 · 6604f76 · 6604f76
1 parent d01aefa
commit 6604f76
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 11 deletions.
diff --git a/.dotnet/CONTRIBUTING.md b/.dotnet/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+# CONTRIBUTING
+
+## How to run code generation
+
+1. Run the following command to install the necessary tools:
+    `npm install`
+1. Regenerate the OpenAPI spec by running the following command:
+    `npx tsp compile .\openai-in-typespec\main.tsp --emit @typespec/openapi3`
+1. Regenerate the library by running the following command:
+    `npx tsp compile .\openai-in-typespec\main.tsp --emit @azure-tools/typespec-csharp --option @azure-tools/typespec-csharp.emitter-output-dir=.\openai-in-typespec\.dotnet`
+1. Run the following script:
+    `.\openai-in-typespec\.dotnet\scripts\Update-ClientModel.ps1`
+1. Run the following script:
+    `.\openai-in-typespec\.dotnet\scripts\ConvertTo-Internal.ps1`
+1. Run the following script:
+    `.\openai-in-typespec\.dotnet\scripts\Add-Customizations.ps1`
diff --git a/.dotnet/Directory.Build.props b/.dotnet/Directory.Build.props
diff --git a/.dotnet/scripts/Add-Customizations.ps1 b/.dotnet/scripts/Add-Customizations.ps1
@@ -24,5 +24,16 @@ function Update-MicrosoftBclAsyncInterfacesPackage {
     Set-Location -Path $current
 }
 
+function Set-LangVersionToLatest {
+    $root = Split-Path $PSScriptRoot -Parent
+    $filePath = Join-Path -Path $root -ChildPath "tests\OpenAI.Tests.csproj"
+    $xml = [xml](Get-Content -Path $filePath)
+    $element = $xml.CreateElement("LangVersion")
+    $element.InnerText = "latest"
+    $xml.Project.PropertyGroup.AppendChild($element) | Out-Null
+    $xml.Save($filePath)
+}
+
 Update-SystemTextJsonPackage
-Update-MicrosoftBclAsyncInterfacesPackage
+Update-MicrosoftBclAsyncInterfacesPackage
+Set-LangVersionToLatest
diff --git a/.dotnet/tests/OpenAI.Tests.csproj b/.dotnet/tests/OpenAI.Tests.csproj
@@ -3,12 +3,11 @@
     <TargetFramework>net7.0</TargetFramework>
     <!--Ignore XML doc comments on test types and members-->
     <NoWarn>$(NoWarn);CS1591</NoWarn>
+    <LangVersion>latest</LangVersion>
   </PropertyGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\src\OpenAI.csproj" />
   </ItemGroup>
-
   <ItemGroup>
     <PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="8.0.0" />
     <PackageReference Include="NUnit" Version="3.13.2" />
@@ -17,4 +16,4 @@
     <PackageReference Include="Moq" Version="[4.18.2]" />
     <PackageReference Include="System.ClientModel" Version="1.1.0-alpha.20240227.1" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/tsp-output/@typespec/openapi3/openapi.yaml b/tsp-output/@typespec/openapi3/openapi.yaml
@@ -5204,6 +5204,7 @@ components:
         bytes:
           type: integer
           format: int64
+          nullable: true
           description: The size of the file, in bytes.
         created_at:
           type: integer
@@ -5375,8 +5376,9 @@ components:
           nullable: true
           description: The last error associated with this run. Will be `null` if there are no errors.
         expires_at:
-          type: integer
-          format: unixtime
+          type: string
+          format: date-time
+          nullable: true
           description: The Unix timestamp (in seconds) for when the run will expire.
         started_at:
           type: string