diff --git a/docs/guides/events.md b/docs/guides/events.md index 0f56271..15d99b8 100644 --- a/docs/guides/events.md +++ b/docs/guides/events.md @@ -14,171 +14,51 @@ Below is a list of supported events and their payloads. `tailordb.type_record.created` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field Name Description
`workspaceId``String`: The workspace ID where the event occurred.
`namespaceName``String`: Name of the application.
`typeName``String`: Name of the type.
`newRecord``Object`: The new record added to Tailor DB.
+| Field Name | Description | +|------------|-------------| +| `workspaceId` | `String`: The workspace ID where the event occurred. | +| `namespaceName` | `String`: Name of the application. | +| `typeName` | `String`: Name of the type. | +| `newRecord` | `Object`: The new record added to Tailor DB. | ### Record Updated `tailordb.type_record.updated` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field Name Description
`workspaceId``String`: The workspace ID where the event occurred.
`namespaceName``String`: Name of the application.
`typeName``String`: Name of the type.
`oldRecord``Object`: The old record in Tailor DB.
`newRecord``Object`: The updated record in Tailor DB.
+| Field Name | Description | +|------------|-------------| +| `workspaceId` | `String`: The workspace ID where the event occurred. | +| `namespaceName` | `String`: Name of the application. | +| `typeName` | `String`: Name of the type. | +| `oldRecord` | `Object`: The old record in Tailor DB. | +| `newRecord` | `Object`: The updated record in Tailor DB. | ### Record Deleted `tailordb.type_record.deleted` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field Name Description
`workspaceId``String`: The workspace ID where the event occurred.
`namespaceName``String`: Name of the application.
`typeName``String`: Name of the type.
`oldRecord``Object`: The deleted record.
+| Field Name | Description | +|------------|-------------| +| `workspaceId` | `String`: The workspace ID where the event occurred. | +| `namespaceName` | `String`: Name of the application. | +| `typeName` | `String`: Name of the type. | +| `oldRecord` | `Object`: The deleted record. | ### File Uploaded `tailordb.type_record_file.uploaded` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field Name Description
`workspaceId``String`: The workspace ID where the event occurred.
`namespaceName``String`: Name of the application.
`typeName``String`: Name of the type.
`metadata.content_type``String`: MIME type of the uploaded file.
`metadata.field_name``String`: Name of the file field that received the upload.
`metadata.last_uploaded_at``DateTime`: Timestamp when the file was uploaded.
`metadata.parent_id``String`: ID of the record that owns the file.
`metadata.sha256sum``String`: SHA256 checksum of the uploaded file.
`metadata.size``Integer`: Size of the uploaded file in bytes.
+| Field Name | Description | +|------------|-------------| +| `workspaceId` | `String`: The workspace ID where the event occurred. | +| `namespaceName` | `String`: Name of the application. | +| `typeName` | `String`: Name of the type. | +| `metadata.content_type` | `String`: MIME type of the uploaded file. | +| `metadata.field_name` | `String`: Name of the file field that received the upload. | +| `metadata.last_uploaded_at` | `DateTime`: Timestamp when the file was uploaded. | +| `metadata.parent_id` | `String`: ID of the record that owns the file. | +| `metadata.sha256sum` | `String`: SHA256 checksum of the uploaded file. | +| `metadata.size` | `Integer`: Size of the uploaded file in bytes. | ## Pipeline @@ -186,41 +66,13 @@ Below is a list of supported events and their payloads. `pipeline.resolver.executed` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field Name Description
`workspaceId``String`: The workspace ID where the event occurred.
`namespaceName``String`: Name of the application.
`resolverName``String`: Name of the pipeline resolver.
`succeeded.result``Object`: The result object contains `pipelines` and `resolver` data.
`failed.error``String`: The error message provides details about the cause of the error.
+| Field Name | Description | +|------------|-------------| +| `workspaceId` | `String`: The workspace ID where the event occurred. | +| `namespaceName` | `String`: Name of the application. | +| `resolverName` | `String`: Name of the pipeline resolver. | +| `succeeded.result` | `Object`: The result object contains `pipelines` and `resolver` data. | +| `failed.error` | `String`: The error message provides details about the cause of the error. | ## Built-in IdP @@ -228,88 +80,28 @@ Below is a list of supported events and their payloads. `idp.user.created` - - - - - - - - - - - - - - - - - - - - - - - - -
Field Name Description
`workspaceId``String`: The workspace ID where the event occurred.
`namespaceName``String`: Name of the application.
`userId``String`: The ID of the created IdP user.
+| Field Name | Description | +|------------|-------------| +| `workspaceId` | `String`: The workspace ID where the event occurred. | +| `namespaceName` | `String`: Name of the application. | +| `userId` | `String`: The ID of the created IdP user. | ### User Updated `idp.user.updated` - - - - - - - - - - - - - - - - - - - - - - - - -
Field Name Description
`workspaceId``String`: The workspace ID where the event occurred.
`namespaceName``String`: Name of the application.
`userId``String`: The ID of the updated IdP user.
+| Field Name | Description | +|------------|-------------| +| `workspaceId` | `String`: The workspace ID where the event occurred. | +| `namespaceName` | `String`: Name of the application. | +| `userId` | `String`: The ID of the updated IdP user. | ### User Deleted `idp.user.deleted` - - - - - - - - - - - - - - - - - - - - - - - - -
Field Name Description
`workspaceId``String`: The workspace ID where the event occurred.
`namespaceName``String`: Name of the application.
`userId``String`: The ID of the deleted IdP user.
+| Field Name | Description | +|------------|-------------| +| `workspaceId` | `String`: The workspace ID where the event occurred. | +| `namespaceName` | `String`: Name of the application. | +| `userId` | `String`: The ID of the deleted IdP user. | diff --git a/docs/guides/tailordb/advanced-settings/overview.md b/docs/guides/tailordb/advanced-settings/overview.md index a21d461..c8776ba 100644 --- a/docs/guides/tailordb/advanced-settings/overview.md +++ b/docs/guides/tailordb/advanced-settings/overview.md @@ -14,49 +14,15 @@ These features include: Below is a table listing all the available `settings`, with each field and its corresponding type. - - - Field Name - Type - - - - - - Aggregation - `bool` - - - - BulkUpsert - `bool` - - - - Draft - `bool` - - - - DefaultQueryLimitSize - `int`: Default number of records returned by a query is 100. - - - - MaxBulkUpsertSize - `int`: Maximum number of records that can be processed in a single bulk upsert operation is limited to 1,000. - - - - PluralForm - `bool` - - - - PublishRecordEvents - `bool` - - +| Field Name | Type | +|------------|------| +| Aggregation | `bool` | +| BulkUpsert | `bool` | +| Draft | `bool` | +| DefaultQueryLimitSize | `int`: Default number of records returned by a query is 100. | +| MaxBulkUpsertSize | `int`: Maximum number of records that can be processed in a single bulk upsert operation is limited to 1,000. | +| PluralForm | `bool` | +| PublishRecordEvents | `bool` | Also, we can utilize the following advanced GraphQL schema configuration to optimize GraphQL queries.