mirror of
https://github.com/hatchet-dev/hatchet.git
synced 2026-05-08 02:49:17 -05:00
Gabe Ruttner
2b910a89de
* feat: add fe posthog config * feat: add fe posthog to metadata endpoint * feat: dynamically load ph on fe * feat: add analyticsOptOut to tenant db * feat: respect opt out * feat: update tenant settings * feat: mask all text
131 lines
2.9 KiB
YAML
131 lines
2.9 KiB
YAML
APIMeta:
|
|
type: object
|
|
properties:
|
|
auth:
|
|
$ref: "#/APIMetaAuth"
|
|
pylonAppId:
|
|
type: string
|
|
description: the Pylon app ID for usepylon.com chat support
|
|
example: 12345678-1234-1234-1234-123456789012
|
|
posthog:
|
|
$ref: "#/APIMetaPosthog"
|
|
|
|
APIMetaAuth:
|
|
type: object
|
|
properties:
|
|
schemes:
|
|
items:
|
|
type: string
|
|
type: array
|
|
description: the supported types of authentication
|
|
example:
|
|
- basic
|
|
- google
|
|
|
|
APIMetaPosthog:
|
|
type: object
|
|
properties:
|
|
apiKey:
|
|
type: string
|
|
description: the PostHog API key
|
|
example: phk_1234567890abcdef
|
|
apiHost:
|
|
type: string
|
|
description: the PostHog API host
|
|
example: https://posthog.example.com
|
|
|
|
ListAPIMetaIntegration:
|
|
type: array
|
|
items:
|
|
$ref: "#/APIMetaIntegration"
|
|
APIMetaIntegration:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: the name of the integration
|
|
example: github
|
|
enabled:
|
|
type: boolean
|
|
description: whether this integration is enabled on the instance
|
|
required:
|
|
- name
|
|
- enabled
|
|
APIError:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: integer
|
|
description: a custom Hatchet error code
|
|
format: uint64
|
|
example: 1400
|
|
field:
|
|
type: string
|
|
description: the field that this error is associated with, if applicable
|
|
example: name
|
|
description:
|
|
type: string
|
|
description: a description for this error
|
|
example: A descriptive error message
|
|
docs_link:
|
|
type: string
|
|
description: "a link to the documentation for this error, if it exists"
|
|
example: github.com/hatchet-dev/hatchet
|
|
required:
|
|
- description
|
|
APIErrors:
|
|
type: object
|
|
properties:
|
|
errors:
|
|
type: array
|
|
items:
|
|
$ref: "#/APIError"
|
|
required:
|
|
- errors
|
|
APIResourceMeta:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: "the id of this resource, in UUID format"
|
|
example: bb214807-246e-43a5-a25d-41761d1cff9e
|
|
minLength: 36
|
|
maxLength: 36
|
|
format: uuid
|
|
createdAt:
|
|
type: string
|
|
description: the time that this resource was created
|
|
format: date-time
|
|
example: 2022-12-13T15:06:48.888358-05:00
|
|
updatedAt:
|
|
type: string
|
|
description: the time that this resource was last updated
|
|
format: date-time
|
|
example: 2022-12-13T15:06:48.888358-05:00
|
|
required:
|
|
- id
|
|
- createdAt
|
|
- updatedAt
|
|
PaginationResponse:
|
|
type: object
|
|
properties:
|
|
current_page:
|
|
type: integer
|
|
description: the current page
|
|
format: int64
|
|
example: 2
|
|
next_page:
|
|
type: integer
|
|
description: the next page
|
|
format: int64
|
|
example: 3
|
|
num_pages:
|
|
type: integer
|
|
description: the total number of pages for listing
|
|
format: int64
|
|
example: 10
|
|
example:
|
|
next_page: 3
|
|
num_pages: 10
|
|
current_page: 2
|