Skip to content

Commit e449914

Browse files
committed
update docgen with new wording
1 parent 0fb4436 commit e449914

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs-devsite/ai.objectschemarequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ export interface ObjectSchemaRequest extends SchemaRequest
2323
2424
| Property | Type | Description |
2525
| --- | --- | --- |
26-
| [optionalProperties](./ai.objectschemarequest.md#objectschemarequestoptionalproperties) | never | This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the <code>Schema.object()</code> helper method. |
26+
| [optionalProperties](./ai.objectschemarequest.md#objectschemarequestoptionalproperties) | never | This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the <code>Schema.object()</code> helper method. Populating this property will cause response errors if the object is not wrapped with <code>Schema.object()</code>. |
2727
| [type](./ai.objectschemarequest.md#objectschemarequesttype) | [SchemaType.OBJECT](./ai.md#schematypeobject_enummember) | |
2828
2929
## ObjectSchemaRequest.optionalProperties
3030
31-
This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the `Schema.object()` helper method.
31+
This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the `Schema.object()` helper method. Populating this property will cause response errors if the object is not wrapped with `Schema.object()`<!-- -->.
3232
3333
<b>Signature:</b>
3434

0 commit comments

Comments
 (0)