release: 0.35.0 (#311)

* chore(internal): remove CI condition (#310)

* chore(internal): update release workflows

* docs: deduplicate and refine comments (#313)

* chore(internal): make test classes internal (#317)

* chore(internal): add generated comment (#318)

* docs: add `build` method comments (#321)

* chore(internal): refactor query param serialization impl and tests (#322)

* chore(internal): rename `getPathParam` (#323)

chore(internal): reorder some params methodsc
chore(internal): delete duplicate tests
chore(internal): refactor some test assertions

* chore(internal): reformat some tests (#324)

chore(internal): generate more tests

* feat(client): don't require params for some service methods (#325)

* chore(internal): add some tests for union classes (#326)

* docs: image url example

* release: 0.35.0

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>
Co-authored-by: meorphis <[email protected]>
Co-authored-by: Tomer Aberbach <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
   lint:
     name: lint
     runs-on: ubuntu-latest
-    if: github.repository == 'openai/openai-java'
+    
 
     steps:
       - uses: actions/checkout@v4
@@ -34,7 +34,6 @@ jobs:
   test:
     name: test
     runs-on: ubuntu-latest
-    if: github.repository == 'openai/openai-java'
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/create-releases.yml

@@ -1,3 +1,3 @@
 {
-  ".": "0.34.1"
+  ".": "0.35.0"
 }

.release-please-manifest.json

@@ -1,2 +1,2 @@
 configured_endpoints: 78
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-c8579861bc21d4d2155a5b9e8e7d54faee8083730673c4d32cbbe573d7fb4116.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-c8579861bc21d4d2155a5b9e8e7d54faee8083730673c4d32cbbe573d7fb4116.yml

.stats.yml

@@ -1,5 +1,36 @@
 # Changelog
 
+## 0.35.0 (2025-03-18)
+
+Full Changelog: [v0.34.1...v0.35.0](https://github.com/openai/openai-java/compare/v0.34.1...v0.35.0)
+
+### Features
+
+* **client:** don't require params for some service methods ([#325](https://github.com/openai/openai-java/issues/325)) ([3ed7cf8](https://github.com/openai/openai-java/commit/3ed7cf88c11b95003b5962f94f848af3511f0525))
+
+
+### Chores
+
+* **internal:** add generated comment ([#318](https://github.com/openai/openai-java/issues/318)) ([44a46b5](https://github.com/openai/openai-java/commit/44a46b5e6651a3cf38f4b5321020a9fa52c5976c))
+* **internal:** add some tests for union classes ([#326](https://github.com/openai/openai-java/issues/326)) ([bd92f57](https://github.com/openai/openai-java/commit/bd92f577231430115d4976a3f4740ef8f09baa07))
+* **internal:** delete duplicate tests ([f95f8bc](https://github.com/openai/openai-java/commit/f95f8bc083cebbfeef127b62d8c5dbaffa2083ed))
+* **internal:** generate more tests ([a05b899](https://github.com/openai/openai-java/commit/a05b899d056538f47a238cac0e6357ce2688861a))
+* **internal:** make test classes internal ([#317](https://github.com/openai/openai-java/issues/317)) ([f9a25b4](https://github.com/openai/openai-java/commit/f9a25b4be4daa5184b9d19896f4e2009285759be))
+* **internal:** refactor query param serialization impl and tests ([#322](https://github.com/openai/openai-java/issues/322)) ([93558fc](https://github.com/openai/openai-java/commit/93558fcecc463b7d6a4f976c2a7889b1c691dc52))
+* **internal:** refactor some test assertions ([f95f8bc](https://github.com/openai/openai-java/commit/f95f8bc083cebbfeef127b62d8c5dbaffa2083ed))
+* **internal:** reformat some tests ([#324](https://github.com/openai/openai-java/issues/324)) ([a05b899](https://github.com/openai/openai-java/commit/a05b899d056538f47a238cac0e6357ce2688861a))
+* **internal:** remove CI condition ([#310](https://github.com/openai/openai-java/issues/310)) ([1cb3294](https://github.com/openai/openai-java/commit/1cb3294f74fa75bca443aaa6f0f3d9127ed7ea14))
+* **internal:** rename `getPathParam` ([#323](https://github.com/openai/openai-java/issues/323)) ([f95f8bc](https://github.com/openai/openai-java/commit/f95f8bc083cebbfeef127b62d8c5dbaffa2083ed))
+* **internal:** reorder some params methodsc ([f95f8bc](https://github.com/openai/openai-java/commit/f95f8bc083cebbfeef127b62d8c5dbaffa2083ed))
+* **internal:** update release workflows ([2b0d392](https://github.com/openai/openai-java/commit/2b0d392b57acc03b393c1052e39326606d9ad2b0))
+
+
+### Documentation
+
+* add `build` method comments ([#321](https://github.com/openai/openai-java/issues/321)) ([31a8e9e](https://github.com/openai/openai-java/commit/31a8e9e507d0242098fc280ad03cb40ab92dcf83))
+* deduplicate and refine comments ([#313](https://github.com/openai/openai-java/issues/313)) ([3e0b2f5](https://github.com/openai/openai-java/commit/3e0b2f5ebea908879f2215bb648027d60e491374))
+* image url example ([39695e4](https://github.com/openai/openai-java/commit/39695e4702c10171e02fb426bc66db61599c365a))
+
 ## 0.34.1 (2025-03-11)
 
 Full Changelog: [v0.34.0...v0.34.1](https://github.com/openai/openai-java/compare/v0.34.0...v0.34.1)

CHANGELOG.md

@@ -9,14 +9,14 @@
 
 <!-- x-release-please-start-version -->
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.34.1)
-[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.34.1/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.34.1)
+[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.35.0)
+[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.35.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.35.0)
 
 <!-- x-release-please-end -->
 
 The OpenAI Java SDK provides convenient access to the OpenAI REST API from applications written in Java.
 
-The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are also available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/0.0.1).
+The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are also available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/0.34.1).
 
 ## Installation
 
@@ -25,7 +25,7 @@ The REST API documentation can be found on [platform.openai.com](https://platfor
 ### Gradle
 
 ```kotlin
-implementation("com.openai:openai-java:0.34.1")
+implementation("com.openai:openai-java:0.35.0")
 ```
 
 ### Maven
@@ -34,7 +34,7 @@ implementation("com.openai:openai-java:0.34.1")
 <dependency>
     <groupId>com.openai</groupId>
     <artifactId>openai-java</artifactId>
-    <version>0.34.1</version>
+    <version>0.35.0</version>
 </dependency>
 ```
 

README.md

@@ -2,10 +2,6 @@
 
 errors=()
 
-if [ -z "${STAINLESS_API_KEY}" ]; then
-  errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organization secrets on GitHub.")
-fi
-
 if [ -z "${SONATYPE_USERNAME}" ]; then
   errors+=("The OPENAI_SONATYPE_USERNAME secret has not been set. Please set it in either this repository's secrets or your organization secrets")
 fi

bin/check-release-environment

@@ -8,7 +8,7 @@ repositories {
 
 allprojects {
     group = "com.openai"
-    version = "0.34.1" // x-release-please-version
+    version = "0.35.0" // x-release-please-version
 }
 
 subprojects {

build.gradle.kts

@@ -161,14 +161,21 @@ class OpenAIOkHttpClient private constructor() {
 
         fun organization(organization: String?) = apply { clientOptions.organization(organization) }
 
+        /** Alias for calling [Builder.organization] with `organization.orElse(null)`. */
         fun organization(organization: Optional<String>) = organization(organization.getOrNull())
 
         fun project(project: String?) = apply { clientOptions.project(project) }
 
+        /** Alias for calling [Builder.project] with `project.orElse(null)`. */
         fun project(project: Optional<String>) = project(project.getOrNull())
 
         fun fromEnv() = apply { clientOptions.fromEnv() }
 
+        /**
+         * Returns an immutable instance of [OpenAIClient].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         */
         fun build(): OpenAIClient =
             OpenAIClientImpl(
                 clientOptions

openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt

@@ -161,14 +161,21 @@ class OpenAIOkHttpClientAsync private constructor() {
 
         fun organization(organization: String?) = apply { clientOptions.organization(organization) }
 
+        /** Alias for calling [Builder.organization] with `organization.orElse(null)`. */
         fun organization(organization: Optional<String>) = organization(organization.getOrNull())
 
         fun project(project: String?) = apply { clientOptions.project(project) }
 
+        /** Alias for calling [Builder.project] with `project.orElse(null)`. */
         fun project(project: Optional<String>) = project(project.getOrNull())
 
         fun fromEnv() = apply { clientOptions.fromEnv() }
 
+        /**
+         * Returns an immutable instance of [OpenAIClientAsync].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         */
         fun build(): OpenAIClientAsync =
             OpenAIClientAsyncImpl(
                 clientOptions