Skip to content

Commit a8c482b

Browse files
chore: Generate the JSON Schema
1 parent 3c18e62 commit a8c482b

File tree

5 files changed

+450
-0
lines changed

5 files changed

+450
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,9 @@ This repository contains definitions for the following CloudEvent data payloads:
154154
|Google Analytics for Firebase|[Proto](proto/google/events/firebase/analytics/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/analytics/v1/AnalyticsLogData.json)|<br>Data Type:<br>`google.events.firebase.analytics.v1.AnalyticsLogData`<br>CloudEvent Type(s):<br>`google.firebase.analytics.log.v1.written`|
155155
|Firebase Authentication|[Proto](proto/google/events/firebase/auth/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/auth/v1/AuthEventData.json)|<br>Data Type:<br>`google.events.firebase.auth.v1.AuthEventData`<br>CloudEvent Type(s):<br>`google.firebase.auth.user.v1.created`<br/>`google.firebase.auth.user.v1.deleted`|
156156
|Firebase Realtime Database|[Proto](proto/google/events/firebase/database/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/database/v1/ReferenceEventData.json)|<br>Data Type:<br>`google.events.firebase.database.v1.ReferenceEventData`<br>CloudEvent Type(s):<br>`google.firebase.database.ref.v1.created`<br/>`google.firebase.database.ref.v1.updated`<br/>`google.firebase.database.ref.v1.deleted`<br/>`google.firebase.database.ref.v1.written`|
157+
|Firebase Data Connect|[Proto](proto/google/events/firebase/dataconnect/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/dataconnect/v1/ConnectorEventData.json)|<br>Data Type:<br>`google.events.firebase.dataconnect.v1.ConnectorEventData`<br>CloudEvent Type(s):<br>`google.firebase.dataconnect.connector.v1.created`<br/>`google.firebase.dataconnect.connector.v1.updated`<br/>`google.firebase.dataconnect.connector.v1.deleted`|
158+
|Firebase Data Connect|[Proto](proto/google/events/firebase/dataconnect/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/dataconnect/v1/SchemaEventData.json)|<br>Data Type:<br>`google.events.firebase.dataconnect.v1.SchemaEventData`<br>CloudEvent Type(s):<br>`google.firebase.dataconnect.schema.v1.created`<br/>`google.firebase.dataconnect.schema.v1.updated`<br/>`google.firebase.dataconnect.schema.v1.deleted`|
159+
|Firebase Data Connect|[Proto](proto/google/events/firebase/dataconnect/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/dataconnect/v1/ServiceEventData.json)|<br>Data Type:<br>`google.events.firebase.dataconnect.v1.ServiceEventData`<br>CloudEvent Type(s):<br>`google.firebase.dataconnect.service.v1.created`<br/>`google.firebase.dataconnect.service.v1.updated`<br/>`google.firebase.dataconnect.service.v1.deleted`|
157160
|Firebase Alerts|[Proto](proto/google/events/firebase/firebasealerts/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/firebasealerts/v1/AlertData.json)|<br>Data Type:<br>`google.events.firebase.firebasealerts.v1.AlertData`<br>CloudEvent Type(s):<br>`google.firebase.firebasealerts.alerts.v1.published`|
158161
|Firebase Remote Config|[Proto](proto/google/events/firebase/remoteconfig/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/remoteconfig/v1/RemoteConfigEventData.json)|<br>Data Type:<br>`google.events.firebase.remoteconfig.v1.RemoteConfigEventData`<br>CloudEvent Type(s):<br>`google.firebase.remoteconfig.remoteConfig.v1.updated`|
159162
|Firebase Test Lab|[Proto](proto/google/events/firebase/testlab/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/testlab/v1/TestMatrixEventData.json)|<br>Data Type:<br>`google.events.firebase.testlab.v1.TestMatrixEventData`<br>CloudEvent Type(s):<br>`google.firebase.testlab.testMatrix.v1.completed`|

jsonschema/catalog.json

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1519,6 +1519,42 @@
15191519
"google.firebase.database.ref.v1.written"
15201520
]
15211521
},
1522+
{
1523+
"url": "https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/dataconnect/v1/ConnectorEventData.json",
1524+
"product": "Firebase Data Connect",
1525+
"name": "ConnectorEventData",
1526+
"description": "The data within all Connector events.",
1527+
"datatype": "google.events.firebase.dataconnect.v1.ConnectorEventData",
1528+
"cloudeventTypes": [
1529+
"google.firebase.dataconnect.connector.v1.created",
1530+
"google.firebase.dataconnect.connector.v1.updated",
1531+
"google.firebase.dataconnect.connector.v1.deleted"
1532+
]
1533+
},
1534+
{
1535+
"url": "https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/dataconnect/v1/SchemaEventData.json",
1536+
"product": "Firebase Data Connect",
1537+
"name": "SchemaEventData",
1538+
"description": "The data within all Schema events.",
1539+
"datatype": "google.events.firebase.dataconnect.v1.SchemaEventData",
1540+
"cloudeventTypes": [
1541+
"google.firebase.dataconnect.schema.v1.created",
1542+
"google.firebase.dataconnect.schema.v1.updated",
1543+
"google.firebase.dataconnect.schema.v1.deleted"
1544+
]
1545+
},
1546+
{
1547+
"url": "https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/dataconnect/v1/ServiceEventData.json",
1548+
"product": "Firebase Data Connect",
1549+
"name": "ServiceEventData",
1550+
"description": "The data within all Service events.",
1551+
"datatype": "google.events.firebase.dataconnect.v1.ServiceEventData",
1552+
"cloudeventTypes": [
1553+
"google.firebase.dataconnect.service.v1.created",
1554+
"google.firebase.dataconnect.service.v1.updated",
1555+
"google.firebase.dataconnect.service.v1.deleted"
1556+
]
1557+
},
15221558
{
15231559
"url": "https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/firebasealerts/v1/AlertData.json",
15241560
"product": "Firebase Alerts",
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
{
2+
"$id": "https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/dataconnect/v1/ConnectorEventData.json",
3+
"name": "ConnectorEventData",
4+
"examples": [],
5+
"package": "google.events.firebase.dataconnect.v1",
6+
"datatype": "google.events.firebase.dataconnect.v1.ConnectorEventData",
7+
"cloudeventTypes": [
8+
"google.firebase.dataconnect.connector.v1.created",
9+
"google.firebase.dataconnect.connector.v1.updated",
10+
"google.firebase.dataconnect.connector.v1.deleted"
11+
],
12+
"product": "Firebase Data Connect",
13+
"$schema": "http://json-schema.org/draft-04/schema#",
14+
"$ref": "#/definitions/ConnectorEventData",
15+
"definitions": {
16+
"ConnectorEventData": {
17+
"properties": {
18+
"payload": {
19+
"$ref": "#/definitions/Connector",
20+
"additionalProperties": true,
21+
"description": "Optional. The Connector event payload. Unset for deletion events."
22+
}
23+
},
24+
"additionalProperties": true,
25+
"type": "object",
26+
"title": "Connector Event Data",
27+
"description": "The data within all Connector events."
28+
},
29+
"Connector": {
30+
"properties": {
31+
"name": {
32+
"type": "string",
33+
"description": "Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```"
34+
},
35+
"createTime": {
36+
"type": "string",
37+
"description": "Output only. [Output only] Create time stamp.",
38+
"format": "date-time"
39+
},
40+
"updateTime": {
41+
"type": "string",
42+
"description": "Output only. [Output only] Update time stamp.",
43+
"format": "date-time"
44+
},
45+
"labels": {
46+
"additionalProperties": {
47+
"type": "string"
48+
},
49+
"type": "object",
50+
"description": "Optional. Labels as key value pairs."
51+
},
52+
"annotations": {
53+
"additionalProperties": {
54+
"type": "string"
55+
},
56+
"type": "object",
57+
"description": "Optional. Stores small amounts of arbitrary data."
58+
},
59+
"source": {
60+
"$ref": "#/definitions/Source",
61+
"additionalProperties": true,
62+
"description": "Required. The source files that comprise the connector."
63+
},
64+
"uid": {
65+
"type": "string",
66+
"description": "Output only. System-assigned, unique identifier."
67+
},
68+
"reconciling": {
69+
"type": "boolean",
70+
"description": "Output only. A field that if true, indicates that the system is working to compile and deploy the connector."
71+
},
72+
"displayName": {
73+
"type": "string",
74+
"description": "Optional. Mutable human-readable name. 63 character limit."
75+
},
76+
"etag": {
77+
"type": "string",
78+
"description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154)"
79+
}
80+
},
81+
"additionalProperties": true,
82+
"type": "object",
83+
"title": "Connector",
84+
"description": "Connector consists of a set of operations, i.e. queries and mutations."
85+
},
86+
"File": {
87+
"properties": {
88+
"path": {
89+
"type": "string",
90+
"description": "Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql)."
91+
},
92+
"content": {
93+
"type": "string",
94+
"description": "Required. The file's textual content."
95+
}
96+
},
97+
"additionalProperties": true,
98+
"type": "object",
99+
"title": "File",
100+
"description": "Individual files."
101+
},
102+
"Source": {
103+
"properties": {
104+
"files": {
105+
"items": {
106+
"$ref": "#/definitions/File"
107+
},
108+
"type": "array",
109+
"description": "Required. The files that comprise the source set."
110+
}
111+
},
112+
"additionalProperties": true,
113+
"type": "object",
114+
"title": "Source",
115+
"description": "Used to represent a set of source files."
116+
}
117+
}
118+
}
Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
{
2+
"$id": "https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/dataconnect/v1/SchemaEventData.json",
3+
"name": "SchemaEventData",
4+
"examples": [],
5+
"package": "google.events.firebase.dataconnect.v1",
6+
"datatype": "google.events.firebase.dataconnect.v1.SchemaEventData",
7+
"cloudeventTypes": [
8+
"google.firebase.dataconnect.schema.v1.created",
9+
"google.firebase.dataconnect.schema.v1.updated",
10+
"google.firebase.dataconnect.schema.v1.deleted"
11+
],
12+
"product": "Firebase Data Connect",
13+
"$schema": "http://json-schema.org/draft-04/schema#",
14+
"$ref": "#/definitions/SchemaEventData",
15+
"definitions": {
16+
"SchemaEventData": {
17+
"properties": {
18+
"payload": {
19+
"$ref": "#/definitions/Schema",
20+
"additionalProperties": true,
21+
"description": "Optional. The Schema event payload. Unset for deletion events."
22+
}
23+
},
24+
"additionalProperties": true,
25+
"type": "object",
26+
"title": "Schema Event Data",
27+
"description": "The data within all Schema events."
28+
},
29+
"CloudSqlInstance": {
30+
"properties": {
31+
"instance": {
32+
"type": "string",
33+
"description": "Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ```"
34+
}
35+
},
36+
"additionalProperties": true,
37+
"type": "object",
38+
"title": "Cloud Sql Instance",
39+
"description": "Settings for CloudSQL instance configuration."
40+
},
41+
"Datasource": {
42+
"properties": {
43+
"postgresql": {
44+
"$ref": "#/definitions/PostgreSql",
45+
"additionalProperties": true,
46+
"description": "PostgreSQL configurations."
47+
}
48+
},
49+
"additionalProperties": true,
50+
"type": "object",
51+
"title": "Datasource",
52+
"description": "A data source that backs Firebase Data Connect services."
53+
},
54+
"File": {
55+
"properties": {
56+
"path": {
57+
"type": "string",
58+
"description": "Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql)."
59+
},
60+
"content": {
61+
"type": "string",
62+
"description": "Required. The file's textual content."
63+
}
64+
},
65+
"additionalProperties": true,
66+
"type": "object",
67+
"title": "File",
68+
"description": "Individual files."
69+
},
70+
"PostgreSql": {
71+
"properties": {
72+
"schemaValidation": {
73+
"enum": [
74+
"SQL_SCHEMA_VALIDATION_UNSPECIFIED",
75+
0,
76+
"NONE",
77+
1,
78+
"STRICT",
79+
2,
80+
"COMPATIBLE",
81+
3
82+
],
83+
"oneOf": [
84+
{
85+
"type": "string"
86+
},
87+
{
88+
"type": "integer"
89+
}
90+
],
91+
"title": "Sql Schema Validation",
92+
"description": "Configure how much SQL Schema to perform for the given schema."
93+
},
94+
"schemaMigration": {
95+
"enum": [
96+
"SQL_SCHEMA_MIGRATION_UNSPECIFIED",
97+
0,
98+
"MIGRATE_COMPATIBLE",
99+
1
100+
],
101+
"oneOf": [
102+
{
103+
"type": "string"
104+
},
105+
{
106+
"type": "integer"
107+
}
108+
],
109+
"title": "Sql Schema Migration",
110+
"description": "Configure how to perform SQL Schema migration before deploying the Schema."
111+
},
112+
"unlinked": {
113+
"type": "boolean",
114+
"description": "No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured."
115+
},
116+
"cloudSql": {
117+
"$ref": "#/definitions/CloudSqlInstance",
118+
"additionalProperties": true,
119+
"description": "Cloud SQL configurations."
120+
},
121+
"database": {
122+
"type": "string",
123+
"description": "Required. Name of the PostgreSQL database."
124+
}
125+
},
126+
"additionalProperties": true,
127+
"type": "object",
128+
"title": "Postgre Sql",
129+
"description": "Settings for PostgreSQL data source."
130+
},
131+
"Schema": {
132+
"properties": {
133+
"name": {
134+
"type": "string",
135+
"description": "Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is \"main\"."
136+
},
137+
"createTime": {
138+
"type": "string",
139+
"description": "Output only. [Output only] Create time stamp.",
140+
"format": "date-time"
141+
},
142+
"updateTime": {
143+
"type": "string",
144+
"description": "Output only. [Output only] Update time stamp.",
145+
"format": "date-time"
146+
},
147+
"labels": {
148+
"additionalProperties": {
149+
"type": "string"
150+
},
151+
"type": "object",
152+
"description": "Optional. Labels as key value pairs."
153+
},
154+
"annotations": {
155+
"additionalProperties": {
156+
"type": "string"
157+
},
158+
"type": "object",
159+
"description": "Optional. Stores small amounts of arbitrary data."
160+
},
161+
"datasources": {
162+
"items": {
163+
"$ref": "#/definitions/Datasource"
164+
},
165+
"type": "array",
166+
"description": "Required. The data sources linked in the schema."
167+
},
168+
"source": {
169+
"$ref": "#/definitions/Source",
170+
"additionalProperties": true,
171+
"description": "Required. The source files that comprise the application schema."
172+
},
173+
"uid": {
174+
"type": "string",
175+
"description": "Output only. System-assigned, unique identifier."
176+
},
177+
"reconciling": {
178+
"type": "boolean",
179+
"description": "Output only. A field that if true, indicates that the system is working to compile and deploy the schema."
180+
},
181+
"displayName": {
182+
"type": "string",
183+
"description": "Optional. Mutable human-readable name. 63 character limit."
184+
},
185+
"etag": {
186+
"type": "string",
187+
"description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154)"
188+
}
189+
},
190+
"additionalProperties": true,
191+
"type": "object",
192+
"title": "Schema",
193+
"description": "The application schema of a Firebase Data Connect service."
194+
},
195+
"Source": {
196+
"properties": {
197+
"files": {
198+
"items": {
199+
"$ref": "#/definitions/File"
200+
},
201+
"type": "array",
202+
"description": "Required. The files that comprise the source set."
203+
}
204+
},
205+
"additionalProperties": true,
206+
"type": "object",
207+
"title": "Source",
208+
"description": "Used to represent a set of source files."
209+
}
210+
}
211+
}

0 commit comments

Comments
 (0)