feat: generate API layer for streaming endpoints

feat: streaming list objects support

Author: SoulPancake

.openapi-generator/FILES

@@ -68,6 +68,8 @@ docs/RelationshipCondition.md
 docs/SourceInfo.md
 docs/Status.md
 docs/Store.md
+docs/StreamResultOfStreamedListObjectsResponse.md
+docs/StreamedListObjectsResponse.md
 docs/Tuple.md
 docs/TupleChange.md
 docs/TupleKey.md
@@ -157,6 +159,8 @@ model_relationship_condition.go
 model_source_info.go
 model_status.go
 model_store.go
+model_stream_result_of_streamed_list_objects_response.go
+model_streamed_list_objects_response.go
 model_tuple.go
 model_tuple_change.go
 model_tuple_key.go

CHANGELOG.md

@@ -3,10 +3,12 @@
 ## [Unreleased](https://github.com/openfga/go-sdk/compare/v0.7.3...HEAD)
 - feat: add generic `ToPtr[T any](v T) *T` function for creating pointers to any type
 - deprecation: `PtrBool`, `PtrInt`, `PtrInt32`, `PtrInt64`, `PtrFloat32`, `PtrFloat64`, `PtrString`, and `PtrTime` are now deprecated in favor of the generic `ToPtr` function
+- feat: add support for StreamedListObjects endpoint
+- feat: add configurable buffer size for streaming responses via `ClientStreamedListObjectsOptions.StreamBufferSize`
 
 ## v0.7.3
 
-### [0.7.3](https://github.com/openfga/go-sdk/compare/v0.7.2...v0.7.3)
+### [0.7.3](https://github.com/openfga/go-sdk/compare/v0.7.2...v0.7.3) (2025-10-08)
 
 - feat: add support for custom headers per request. See [documentation](https://github.com/openfga/go-sdk#custom-headers).
 - feat: add support for conflict options for Write operations**: (#229)

CONTRIBUTING.md

@@ -10,7 +10,7 @@ Reading and following these guidelines will help us make the contribution proces
 * [Getting Started](#getting-started)
     * [Making Changes](#making-changes)
     * [Opening Issues](#opening-issues)
-    * [Submitting Pull Requests](#submitting-pull-requests) [Note: We are not accepting Pull Requests at this time!]
+    * [Submitting Pull Requests](#submitting-pull-requests)
 * [Getting in Touch](#getting-in-touch)
     * [Have a question or problem?](#have-a-question-or-problem)
     * [Vulnerability Reporting](#vulnerability-reporting)

README.md

@@ -1101,6 +1101,7 @@ Class | Method | HTTP request | Description
 *OpenFgaApi* | [**ReadAuthorizationModel**](docs/OpenFgaApi.md#readauthorizationmodel) | **Get** /stores/{store_id}/authorization-models/{id} | Return a particular version of an authorization model
 *OpenFgaApi* | [**ReadAuthorizationModels**](docs/OpenFgaApi.md#readauthorizationmodels) | **Get** /stores/{store_id}/authorization-models | Return all the authorization models for a particular store
 *OpenFgaApi* | [**ReadChanges**](docs/OpenFgaApi.md#readchanges) | **Get** /stores/{store_id}/changes | Return a list of all the tuple changes
+*OpenFgaApi* | [**StreamedListObjects**](docs/OpenFgaApi.md#streamedlistobjects) | **Post** /stores/{store_id}/streamed-list-objects | Stream all objects of the given type that the user has a relation with
 *OpenFgaApi* | [**Write**](docs/OpenFgaApi.md#write) | **Post** /stores/{store_id}/write | Add or delete tuples from the store
 *OpenFgaApi* | [**WriteAssertions**](docs/OpenFgaApi.md#writeassertions) | **Put** /stores/{store_id}/assertions/{authorization_model_id} | Upsert assertions for an authorization model ID
 *OpenFgaApi* | [**WriteAuthorizationModel**](docs/OpenFgaApi.md#writeauthorizationmodel) | **Post** /stores/{store_id}/authorization-models | Create a new authorization model
@@ -1166,6 +1167,8 @@ Class | Method | HTTP request | Description
  - [SourceInfo](docs/SourceInfo.md)
  - [Status](docs/Status.md)
  - [Store](docs/Store.md)
+ - [StreamResultOfStreamedListObjectsResponse](docs/StreamResultOfStreamedListObjectsResponse.md)
+ - [StreamedListObjectsResponse](docs/StreamedListObjectsResponse.md)
  - [Tuple](docs/Tuple.md)
  - [TupleChange](docs/TupleChange.md)
  - [TupleKey](docs/TupleKey.md)

api_open_fga.go

@@ -771,6 +771,24 @@ type OpenFgaApi interface {
 	 */
 	ReadChangesExecute(r ApiReadChangesRequest) (ReadChangesResponse, *http.Response, error)
 
+	/*
+		 * StreamedListObjects Stream all objects of the given type that the user has a relation with
+		 * The Streamed ListObjects API is very similar to the the ListObjects API, with two differences:
+	1. Instead of collecting all objects before returning a response, it streams them to the client as they are collected.
+	2. The number of results returned is only limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE.
+
+		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+		 * @param storeId
+		 * @return ApiStreamedListObjectsRequest
+	*/
+	StreamedListObjects(ctx context.Context, storeId string) ApiStreamedListObjectsRequest
+
+	/*
+	 * StreamedListObjectsExecute executes the request
+	 * @return StreamResultOfStreamedListObjectsResponse
+	 */
+	StreamedListObjectsExecute(r ApiStreamedListObjectsRequest) (StreamResultOfStreamedListObjectsResponse, *http.Response, error)
+
 	/*
 		 * Write Add or delete tuples from the store
 		 * The Write API will transactionally update the tuples for a certain store. Tuples and type definitions allow OpenFGA to determine whether a relationship exists between an object and an user.
@@ -4170,6 +4188,202 @@ func (a *OpenFgaApiService) ReadChangesExecute(r ApiReadChangesRequest) (ReadCha
 	return returnValue, nil, reportError("Error not handled properly")
 }
 
+type ApiStreamedListObjectsRequest struct {
+	ctx        context.Context
+	ApiService OpenFgaApi
+	storeId    string
+	body       *ListObjectsRequest
+	options    RequestOptions
+}
+
+func (r ApiStreamedListObjectsRequest) Body(body ListObjectsRequest) ApiStreamedListObjectsRequest {
+	r.body = &body
+	return r
+}
+
+func (r ApiStreamedListObjectsRequest) Options(options RequestOptions) ApiStreamedListObjectsRequest {
+	r.options = options
+	return r
+}
+
+func (r ApiStreamedListObjectsRequest) Execute() (StreamResultOfStreamedListObjectsResponse, *http.Response, error) {
+	return r.ApiService.StreamedListObjectsExecute(r)
+}
+
+/*
+  - StreamedListObjects Stream all objects of the given type that the user has a relation with
+  - The Streamed ListObjects API is very similar to the the ListObjects API, with two differences:
+
+1. Instead of collecting all objects before returning a response, it streams them to the client as they are collected.
+2. The number of results returned is only limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE.
+
+  - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+  - @param storeId
+  - @return ApiStreamedListObjectsRequest
+*/
+func (a *OpenFgaApiService) StreamedListObjects(ctx context.Context, storeId string) ApiStreamedListObjectsRequest {
+	return ApiStreamedListObjectsRequest{
+		ApiService: a,
+		ctx:        ctx,
+		storeId:    storeId,
+	}
+}
+
+/*
+ * Execute executes the request
+ * @return StreamResultOfStreamedListObjectsResponse
+ */
+func (a *OpenFgaApiService) StreamedListObjectsExecute(r ApiStreamedListObjectsRequest) (StreamResultOfStreamedListObjectsResponse, *http.Response, error) {
+	const (
+		operationName = "StreamedListObjects"
+		httpMethod    = http.MethodPost
+	)
+	var (
+		requestStarted = time.Now()
+		requestBody    interface{}
+		returnValue    StreamResultOfStreamedListObjectsResponse
+	)
+
+	path := "/stores/{store_id}/streamed-list-objects"
+	if r.storeId == "" {
+		return returnValue, nil, reportError("storeId is required and must be specified")
+	}
+
+	path = strings.ReplaceAll(path, "{"+"store_id"+"}", url.PathEscape(parameterToString(r.storeId, "")))
+
+	localVarHeaderParams := make(map[string]string)
+	localVarQueryParams := url.Values{}
+	if r.body == nil {
+		return returnValue, nil, reportError("body is required and must be specified")
+	}
+
+	// to determine the Content-Type header
+	localVarHTTPContentTypes := []string{"application/json"}
+
+	// set Content-Type header
+	localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+	if localVarHTTPContentType != "" {
+		localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+	}
+
+	// to determine the Accept header
+	localVarHTTPHeaderAccepts := []string{"application/json"}
+
+	// set Accept header
+	localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+	if localVarHTTPHeaderAccept != "" {
+		localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+	}
+	// body params
+	requestBody = r.body
+
+	// if any override headers were in the options, set them now
+	for header, val := range r.options.Headers {
+		localVarHeaderParams[header] = val
+	}
+
+	retryParams := a.client.cfg.RetryParams
+	for i := 0; i < retryParams.MaxRetry+1; i++ {
+		req, err := a.client.prepareRequest(r.ctx, path, httpMethod, requestBody, localVarHeaderParams, localVarQueryParams)
+		if err != nil {
+			return returnValue, nil, err
+		}
+
+		httpResponse, err := a.client.callAPI(req)
+		if err != nil || httpResponse == nil {
+			if i < retryParams.MaxRetry {
+				timeToWait := retryutils.GetTimeToWait(i, retryParams.MaxRetry, retryParams.MinWaitInMs, http.Header{}, operationName)
+				if timeToWait > 0 {
+					if a.client.cfg.Debug {
+						log.Printf("\nWaiting %v to retry %v (%v %v) due to network error (error=%v) on attempt %v. Request body: %v\n", timeToWait, operationName, req.Method, req.URL, err, i, requestBody)
+					}
+					time.Sleep(timeToWait)
+					continue
+				}
+			}
+			return returnValue, httpResponse, err
+		}
+
+		responseBody, err := io.ReadAll(httpResponse.Body)
+		_ = httpResponse.Body.Close()
+		httpResponse.Body = io.NopCloser(bytes.NewBuffer(responseBody))
+		if err != nil {
+			if i < retryParams.MaxRetry {
+				timeToWait := retryutils.GetTimeToWait(i, retryParams.MaxRetry, retryParams.MinWaitInMs, httpResponse.Header, operationName)
+				if timeToWait > 0 {
+					if a.client.cfg.Debug {
+						log.Printf("\nWaiting %v to retry %v (%v %v) due to error parsing response body (err=%v) on attempt %v. Request body: %v\n", timeToWait, operationName, req.Method, req.URL, err, i, requestBody)
+					}
+					time.Sleep(timeToWait)
+					continue
+				}
+			}
+			return returnValue, httpResponse, err
+		}
+
+		if httpResponse.StatusCode >= http.StatusMultipleChoices {
+			err := a.client.handleAPIError(httpResponse, responseBody, requestBody, operationName, r.storeId)
+			if err != nil && i < retryParams.MaxRetry {
+				timeToWait := time.Duration(0)
+				var fgaApiRateLimitExceededError FgaApiRateLimitExceededError
+				var fgaApiInternalError FgaApiInternalError
+				switch {
+				case errors.As(err, &fgaApiRateLimitExceededError):
+					timeToWait = err.(FgaApiRateLimitExceededError).GetTimeToWait(i, *retryParams)
+				case errors.As(err, &fgaApiInternalError):
+					timeToWait = err.(FgaApiInternalError).GetTimeToWait(i, *retryParams)
+				}
+
+				if timeToWait > 0 {
+					if a.client.cfg.Debug {
+						log.Printf("\nWaiting %v to retry %v (%v %v) due to api retryable error (status code %v, error=%v) on attempt %v. Request body: %v\n", timeToWait, operationName, req.Method, req.URL, httpResponse.StatusCode, err, i, requestBody)
+					}
+					time.Sleep(timeToWait)
+					continue
+				}
+			}
+
+			return returnValue, httpResponse, err
+		}
+
+		err = a.client.decode(&returnValue, responseBody, httpResponse.Header.Get("Content-Type"))
+		if err != nil {
+			newErr := GenericOpenAPIError{
+				body:  responseBody,
+				error: err.Error(),
+			}
+			return returnValue, httpResponse, newErr
+		}
+
+		metrics := telemetry.GetMetrics(telemetry.TelemetryFactoryParameters{Configuration: a.client.cfg.Telemetry})
+
+		var attrs, queryDuration, requestDuration, _ = metrics.BuildTelemetryAttributes(
+			operationName,
+			map[string]interface{}{
+				"storeId": r.storeId,
+				"body":    requestBody,
+			},
+			req,
+			httpResponse,
+			requestStarted,
+			i,
+		)
+
+		if requestDuration > 0 {
+			_, _ = metrics.RequestDuration(requestDuration, attrs)
+		}
+
+		if queryDuration > 0 {
+			_, _ = metrics.QueryDuration(queryDuration, attrs)
+		}
+
+		return returnValue, httpResponse, nil
+	}
+
+	// should never have reached this
+	return returnValue, nil, reportError("Error not handled properly")
+}
+
 type ApiWriteRequest struct {
 	ctx        context.Context
 	ApiService OpenFgaApi