mirror of
https://github.com/hatchet-dev/hatchet.git
synced 2026-03-18 10:42:44 -05:00
ee68786d69
* wip * wip: functional query * feat: expose affinity config * feat: add weight to proto * feat: upsert affinity state on worker start * fix: linting * feat: add upsert proto * feat: upsert handler * feat: revise model * fix: labels * feat: functional desired worker * wip: ui * feat: add state to step run events * fix: filter empty keys * fix: labels as badges * feat: empty state and descriptive text * chore: add todo * chore: whitespace * chore: cleanup * chore: cleanup * chore: fix hash * chore: squash migrations * fix: fair worker assignment * fix: remaining slots on valid desired workers * wip: sticky * fix: count slots * chore: rm log line * feat: expose sticky config * wip: sticky dag * feat: expose desired worker id to trigger * feat: trigger on desired worker * feat: typescript docs * feat: sticky python * feat: py sticky children * wip: py affinity * serverless note * feat: complete python examples * linting * fix: doc link * chore: rm debug log * fix: simplify list labels * fix: typo
146 lines
3.4 KiB
YAML
146 lines
3.4 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"
|
|
allowSignup:
|
|
type: boolean
|
|
description: whether or not users can sign up for this instance
|
|
example: true
|
|
allowInvites:
|
|
type: boolean
|
|
description: whether or not users can invite other users to this instance
|
|
example: true
|
|
allowCreateTenant:
|
|
type: boolean
|
|
description: whether or not users can create new tenants
|
|
example: true
|
|
allowChangePassword:
|
|
type: boolean
|
|
description: whether or not users can change their password
|
|
example: true
|
|
|
|
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: 0
|
|
maxLength: 36
|
|
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
|