Skip to content

Commit d84e51f

Browse files
hsubox76hsubox76
committed
fix docs
1 parent 1ee080b commit d84e51f

18 files changed

+829
-642
lines changed

‎common/api-review/vertexai.api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export class ArraySchema extends Schema {
1414
constructor(schemaParams: SchemaParams, items: TypedSchema);
1515
// (undocumented)
1616
items: TypedSchema;
17-
// (undocumented)
17+
// @internal (undocumented)
1818
toJSON(): SchemaRequest;
1919
}
2020

@@ -494,7 +494,7 @@ export class ObjectSchema extends Schema {
494494
properties: {
495495
[k: string]: TypedSchema;
496496
};
497-
// (undocumented)
497+
// @internal (undocumented)
498498
toJSON(): SchemaRequest;
499499
}
500500

@@ -711,7 +711,7 @@ export class StringSchema extends Schema {
711711
constructor(schemaParams?: SchemaParams, enumValues?: string[]);
712712
// (undocumented)
713713
enum?: string[];
714-
// (undocumented)
714+
// @internal (undocumented)
715715
toJSON(): SchemaRequest;
716716
}
717717

‎docs-devsite/_toc.yaml

Lines changed: 0 additions & 559 deletions
This file was deleted.

‎docs-devsite/vertexai-preview.arrayschema.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ArraySchema class
13+
Schema class for "array" types. The `items` param should refer to the type of item that can be a member of the array.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class ArraySchema extends Schema
19+
```
20+
<b>Extends:</b> [Schema](./vertexai-preview.schema.md#schema_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(schemaParams, items)](./vertexai-preview.arrayschema.md#arrayschemaconstructor) | | Constructs a new instance of the <code>ArraySchema</code> class |
27+
28+
## Properties
29+
30+
| Property | Modifiers | Type | Description |
31+
| --- | --- | --- | --- |
32+
| [items](./vertexai-preview.arrayschema.md#arrayschemaitems) | | [TypedSchema](./vertexai-preview.md#typedschema) | |
33+
34+
## ArraySchema.(constructor)
35+
36+
Constructs a new instance of the `ArraySchema` class
37+
38+
<b>Signature:</b>
39+
40+
```typescript
41+
constructor(schemaParams: SchemaParams, items: TypedSchema);
42+
```
43+
44+
#### Parameters
45+
46+
| Parameter | Type | Description |
47+
| --- | --- | --- |
48+
| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | |
49+
| items | [TypedSchema](./vertexai-preview.md#typedschema) | |
50+
51+
## ArraySchema.items
52+
53+
<b>Signature:</b>
54+
55+
```typescript
56+
items: TypedSchema;
57+
```

‎docs-devsite/vertexai-preview.booleanschema.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# BooleanSchema class
13+
Schema class for "boolean" types.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class BooleanSchema extends Schema
19+
```
20+
<b>Extends:</b> [Schema](./vertexai-preview.schema.md#schema_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(schemaParams)](./vertexai-preview.booleanschema.md#booleanschemaconstructor) | | Constructs a new instance of the <code>BooleanSchema</code> class |
27+
28+
## BooleanSchema.(constructor)
29+
30+
Constructs a new instance of the `BooleanSchema` class
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
constructor(schemaParams?: SchemaParams);
36+
```
37+
38+
#### Parameters
39+
40+
| Parameter | Type | Description |
41+
| --- | --- | --- |
42+
| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | |
43+

‎docs-devsite/vertexai-preview.integerschema.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# IntegerSchema class
13+
Schema class for "integer" types.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class IntegerSchema extends Schema
19+
```
20+
<b>Extends:</b> [Schema](./vertexai-preview.schema.md#schema_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(schemaParams)](./vertexai-preview.integerschema.md#integerschemaconstructor) | | Constructs a new instance of the <code>IntegerSchema</code> class |
27+
28+
## IntegerSchema.(constructor)
29+
30+
Constructs a new instance of the `IntegerSchema` class
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
constructor(schemaParams?: SchemaParams);
36+
```
37+
38+
#### Parameters
39+
40+
| Parameter | Type | Description |
41+
| --- | --- | --- |
42+
| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | |
43+

‎docs-devsite/vertexai-preview.numberschema.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# NumberSchema class
13+
Schema class for "number" types.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class NumberSchema extends Schema
19+
```
20+
<b>Extends:</b> [Schema](./vertexai-preview.schema.md#schema_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(schemaParams)](./vertexai-preview.numberschema.md#numberschemaconstructor) | | Constructs a new instance of the <code>NumberSchema</code> class |
27+
28+
## NumberSchema.(constructor)
29+
30+
Constructs a new instance of the `NumberSchema` class
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
constructor(schemaParams?: SchemaParams);
36+
```
37+
38+
#### Parameters
39+
40+
| Parameter | Type | Description |
41+
| --- | --- | --- |
42+
| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | |
43+

‎docs-devsite/vertexai-preview.objectschema.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ObjectSchema class
13+
Schema class for "object" types. The `properties` param must be a map of Schema.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class ObjectSchema extends Schema
19+
```
20+
<b>Extends:</b> [Schema](./vertexai-preview.schema.md#schema_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(schemaParams, properties, optionalProperties)](./vertexai-preview.objectschema.md#objectschemaconstructor) | | Constructs a new instance of the <code>ObjectSchema</code> class |
27+
28+
## Properties
29+
30+
| Property | Modifiers | Type | Description |
31+
| --- | --- | --- | --- |
32+
| [optionalProperties](./vertexai-preview.objectschema.md#objectschemaoptionalproperties) | | string\[\] | |
33+
| [properties](./vertexai-preview.objectschema.md#objectschemaproperties) | | { \[k: string\]: [TypedSchema](./vertexai-preview.md#typedschema)<!-- -->; } | |
34+
35+
## ObjectSchema.(constructor)
36+
37+
Constructs a new instance of the `ObjectSchema` class
38+
39+
<b>Signature:</b>
40+
41+
```typescript
42+
constructor(schemaParams: SchemaParams, properties: {
43+
[k: string]: TypedSchema;
44+
}, optionalProperties?: string[]);
45+
```
46+
47+
#### Parameters
48+
49+
| Parameter | Type | Description |
50+
| --- | --- | --- |
51+
| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | |
52+
| properties | { \[k: string\]: [TypedSchema](./vertexai-preview.md#typedschema)<!-- -->; } | |
53+
| optionalProperties | string\[\] | |
54+
55+
## ObjectSchema.optionalProperties
56+
57+
<b>Signature:</b>
58+
59+
```typescript
60+
optionalProperties: string[];
61+
```
62+
63+
## ObjectSchema.properties
64+
65+
<b>Signature:</b>
66+
67+
```typescript
68+
properties: {
69+
[k: string]: TypedSchema;
70+
};
71+
```

‎docs-devsite/vertexai-preview.objectschemainterface.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ObjectSchemaInterface interface
13+
Interface for [ObjectSchema](./vertexai-preview.objectschema.md#objectschema_class) class.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface ObjectSchemaInterface extends SchemaInterface
19+
```
20+
<b>Extends:</b> [SchemaInterface](./vertexai-preview.schemainterface.md#schemainterface_interface)
21+
22+
## Properties
23+
24+
| Property | Type | Description |
25+
| --- | --- | --- |
26+
| [optionalProperties](./vertexai-preview.objectschemainterface.md#objectschemainterfaceoptionalproperties) | string\[\] | |
27+
| [type](./vertexai-preview.objectschemainterface.md#objectschemainterfacetype) | [SchemaType.OBJECT](./vertexai-preview.md#schematypeobject_enummember) | |
28+
29+
## ObjectSchemaInterface.optionalProperties
30+
31+
<b>Signature:</b>
32+
33+
```typescript
34+
optionalProperties?: string[];
35+
```
36+
37+
## ObjectSchemaInterface.type
38+
39+
<b>Signature:</b>
40+
41+
```typescript
42+
type: SchemaType.OBJECT;
43+
```

0 commit comments

Comments
 (0)