schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
prettierrc.json
|
trailingComma
|
Trailing commas wherever possible (including function arguments).
|
{"enum": ["all"]}
|
prettierrc.json
|
useTabs
|
Indent with tabs instead of spaces.
|
{"default": false, "type": "boolean"}
|
prettierrc.json
|
vueIndentScriptAndStyle
|
Indent script and style tags in Vue files.
|
{"default": false, "type": "boolean"}
|
prettierrc.json
|
overrides
|
Provide a list of patterns to override prettier configuration.
|
{"type": "array", "items": {"type": "object", "required": ["files"], "properties": {"files": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "excludeFiles": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "options": {"type": "object"}}, "additionalProperties": false}}
|
prettierrc.json
|
files
|
Include these files in this override.
|
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
|
prettierrc.json
|
excludeFiles
|
Exclude these files from this override.
|
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
|
prettierrc.json
|
options
|
The options to apply for this override.
|
{"type": "object"}
|
lotus.yaml.json
|
livenessProbe
|
Periodic probe of container liveness.
Container will be restarted if the probe fails.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
{}
|
lotus.yaml.json
|
readinessProbe
|
Periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
{}
|
lotus.yaml.json
|
name
|
Unique name for the component. It must be DNS-friendly
|
{"type": "string", "maxLength": 24, "pattern": "^[a-z][a-z\\d-\\.]*[a-z\\d]$"}
|
lotus.yaml.json
|
type
|
The type of component.
|
{"type": "string", "enum": ["http", "worker", "predeploy", "grpc-sso-proxy", "cron"]}
|
lotus.yaml.json
|
service_name
|
The service name is only useful for grpc-sso-proxy components. If present,
a health service will be spun up for the service name, and it can be
possible to perform auto updates of binaries.
|
{"type": "string"}
|
lotus.yaml.json
|
command
|
Command describes how to run the workload
|
{"type": "string"}
|
lotus.yaml.json
|
sso_proxy
|
SSO Proxy settings for http components (grpc-sso-proxy has it enabled by default)
|
{}
|
lotus.yaml.json
|
autoscaling
|
Autoscaling settings for components of type http, grpc-sso-proxy or worker
|
{}
|
lotus.yaml.json
|
clientOf
|
datastores that connect to otherones need to pass in the reference claim here
|
{}
|
lotus.yaml.json
|
name
|
The application name should match the repository's
|
{"type": "string", "maxLength": 24, "pattern": "^[a-z][a-z\\d-\\.]*[a-z\\d]$"}
|
lotus.yaml.json
|
components
|
Workloads to run
|
{"items": {}, "type": "array"}
|
lotus.yaml.json
|
auth_tokens
|
Tokens minted to securely interact with other applications
|
{"items": {"type": "string"}, "type": "array"}
|
lotus.yaml.json
|
firewall_rules
|
Named egress rules
|
{"items": {"type": "string"}, "type": "array"}
|
lotus.yaml.json
|
datastores
|
List of datastores to provision
|
{"items": {}, "type": "array"}
|
lotus.yaml.json
|
pass_auth_header
|
pass OIDC IDToken to upstream via Authorization Bearer header
|
{"type": "boolean"}
|
lotus.yaml.json
|
allow_bearer_auth
|
skip requests that have verified JWT bearer tokens
|
{"type": "boolean"}
|
lotus.yaml.json
|
skip_auth
|
bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods
|
{"items": {"type": "string"}, "type": "array"}
|
api.json
|
$filter
|
An OData filter
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter
|
{"name": "$filter", "in": "query", "schema": {"type": "string"}}
|
api.json
|
$orderby
|
An OData filter
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter
|
{"name": "$orderby", "in": "query", "schema": {"type": "string"}}
|
api.json
|
$select
|
The OData `$select` query option.
This is a comma separated string of fields to select. Only filtering flat properties is
supported.
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect
|
{"name": "$select", "in": "query", "schema": {"type": "string"}}
|
api.json
|
$team
|
A custom filter for filtering the query by teams the requesting user is a member of.
|
{"name": "$team", "in": "query", "schema": {"enum": ["member", "manager"]}}
|
api.json
|
$top
|
Limit the number of entities returned.
|
{"name": "$top", "in": "query", "schema": {"type": "string"}}
|
api.json
|
appId
|
The ID of the app on which to perform an operation
|
{"name": "appId", "in": "path", "required": true, "schema": {}}
|
api.json
|
appOAuth2SecretId
|
The ID of the app OAuth2 secret on which to perform an operation
|
{"name": "appOAuth2SecretId", "in": "path", "required": true, "schema": {}}
|
api.json
|
appSamlSecretId
|
The ID of the app SAML secret on which to perform an operation
|
{"name": "appSamlSecretId", "in": "path", "required": true, "schema": {"type": "string"}}
|
api.json
|
appServiceId
|
The id of the app service secret on which to perform an operation
|
{"name": "appServiceId", "in": "path", "required": true, "schema": {"type": "string"}}
|
api.json
|
assetId
|
The ID of the asset on which to perform an operation
|
{"name": "assetId", "in": "path", "required": true, "schema": {}}
|
api.json
|
blockId
|
The ID of the block on which to perform an operation, but without the organization scope.
|
{"name": "blockId", "in": "path", "required": true, "schema": {"type": "string", "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}}
|
api.json
|
blockVersion
|
The version of the block on which to perform an operation.
|
{"name": "blockVersion", "in": "path", "required": true, "schema": {}}
|
api.json
|
endpoint
|
The URL of the endpoint associated with the subscription.
|
{"name": "endpoint", "in": "query", "required": true, "schema": {"type": "string", "format": "uri"}}
|
api.json
|
language
|
The language on which to perform an operation
|
{"name": "language", "in": "path", "required": true, "schema": {"type": "string"}}
|
api.json
|
organizationId
|
The ID of the organization on which to perform an operation
|
{"name": "organizationId", "in": "path", "required": true, "schema": {}}
|
api.json
|
resourceId
|
The ID of the resource on which to perform an operation
|
{"name": "resourceId", "in": "path", "required": true, "schema": {}}
|
api.json
|
resourceType
|
The type of the resource on which to perform an operation
|
{"name": "resourceType", "in": "path", "required": true, "schema": {"type": "string"}}
|
api.json
|
screenshotId
|
The ID of the app an app screenshot
|
{"name": "screenshotId", "in": "path", "required": true, "schema": {"type": "number"}}
|
api.json
|
view
|
The view of the resource to fetch.
|
{"name": "view", "in": "query", "schema": {"type": "string"}}
|
api.json
|
oauth2Consent
|
The OAuth2 client credentials
|
{"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["appId", "redirectUri", "scope"], "additionalProperties": false, "properties": {"appId": {"type": "number"}, "redirectUri": {"type": "string", "format": "uri"}, "scope": {"type": "string"}}}}}}
|
api.json
|
schema
|
A representation of a user’s OAuth2 consent when logging in to an app.
|
{"type": "object", "required": ["appId", "redirectUri", "scope"], "additionalProperties": false, "properties": {"appId": {"type": "number"}, "redirectUri": {"type": "string", "format": "uri"}, "scope": {"type": "string"}}}
|
api.json
|
appId
|
The app ID to manage the OAuth2 consent for
|
{"type": "number"}
|
api.json
|
redirectUri
|
The URI to redirect the user back to.
|
{"type": "string", "format": "uri"}
|
api.json
|
scope
|
The OAuth2 scope requested by the app.
|
{"type": "string"}
|
api.json
|
resource
|
A resource definition
|
{"content": {"application/json": {"schema": {}}, "multipart/form-data": {"schema": {"type": "object", "required": ["resource"], "additionalProperties": false, "properties": {"resource": {}, "assets": {"type": "array", "items": {"type": "string", "format": "binary"}}}}}}}
|
api.json
|
schema
|
A `multipart/form-data` representation of a resource.
|
{"type": "object", "required": ["resource"], "additionalProperties": false, "properties": {"resource": {}, "assets": {"type": "array", "items": {"type": "string", "format": "binary"}}}}
|
api.json
|
assets
|
A list of assets that should be linked to the resource.
|
{"type": "array", "items": {"type": "string", "format": "binary"}}
|
api.json
|
user
|
A user profile
|
{"content": {"application/json": {"schema": {}}}}
|
api.json
|
app
|
An app response
|
{"content": {"application/json": {"schema": {}}}}
|
api.json
|
blockVersion
|
A block definition response
|
{"content": {"application/json": {"schema": {}}}}
|
api.json
|
default
|
The default error response.
|
{"content": {"application/json": {"schema": {}}}}
|
api.json
|
invite
|
An invite response
|
{"content": {"application/json": {"schema": {}}}}
|
api.json
|
oauth2AuthorizationCode
|
An OAuth2 authorization code.
|
{"content": {"application/json": {"schema": {}}}}
|
api.json
|
organization
|
An organization response
|
{"content": {"application/json": {"schema": {}}}}
|
api.json
|
resource
|
A resource response
|
{"content": {"application/json": {"schema": {}}, "text/csv": {"schema": {"type": "string"}}}}
|
api.json
|
subscriptions
|
A subscription response.
|
{"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}}}}
|
api.json
|
schema
|
A mapping of resources names to resource subscriptions.
|
{"type": "object", "additionalProperties": {}}
|
api.json
|
ActionDefinition
|
The base properties of an action definition.
|
{"type": "object", "additionalProperties": true, "properties": {"remapBefore": {}, "remapAfter": {}, "onSuccess": {}, "onError": {}}}
|
api.json
|
remapBefore
|
This may be used to remap data before it is passed into the action function.
|
{}
|
api.json
|
remapAfter
|
This may be used to remap data after it is passed into the action function.
|
{}
|
api.json
|
onSuccess
|
Another action that is dispatched when the action has been dispatched successfully.
|
{}
|
api.json
|
onError
|
Another action that is dispatched when the action has failed to dispatch successfully.
|
{}
|
api.json
|
type
|
This action sends a Google Analytics event.
It returns the input data.
|
{"enum": ["analytics"]}
|
api.json
|
target
|
The name of the analytics target event to send.
|
{"type": "string"}
|
api.json
|
config
|
A remapper whose result will be sent to Google Analytics as additional context
|
{}
|
api.json
|
App
|
An app definition defines what an app will look like.
|
{"type": "object", "additionalProperties": false, "properties": {"id": {"type": "number", "minimum": 0, "readOnly": true}, "OrganizationId": {}, "path": {"type": "string", "minLength": 1, "maxLength": 30, "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}, "domain": {"anyOf": [{"type": "string", "maxLength": 0}, {"type": "string", "format": "hostname"}]}, "visibility": {"default": "unlisted", "enum": ["public", "unlisted", "private"]}, "showAppDefinition": {"type": "boolean"}, "locked": {"type": "boolean"}, "template": {"type": "boolean"}, "longDescription": {"type": "string"}, "definition": {}, "screenshotUrls": {"type": "array", "items": {"type": "string"}}, "googleAnalyticsID": {"type": "string", "pattern": "^(|UA-\\d{4,10}-\\d{1,4}|G-[\\dA-Z]{4,})$"}, "sentryDsn": {"type": "string", "format": "url"}, "sentryEnvironment": {"type": "string"}}}
|
api.json
|
id
|
The unique identifier for the app.
This value will be generated automatically by the API.
|
{"type": "number", "minimum": 0, "readOnly": true}
|
api.json
|
path
|
The URL path segment on which this app is reachable.
This may only contain lower case characters, numbers, and hyphens. By default this is a
normalized version of the app name.
|
{"type": "string", "minLength": 1, "maxLength": 30, "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}
|
api.json
|
domain
|
The domain name on which this app should be served.
If this is unspecified, the app will be served from the path on the domain of the server
`HOSTNAME` variable.
|
{"anyOf": [{"type": "string", "maxLength": 0}, {"type": "string", "format": "hostname"}]}
|
api.json
|
visibility
|
Determine the app visibility of the app in the Appsemble app store.
This doesn’t affect whether or not the app can be accessed on its own domain.
- **public**: The app is publicly listed in the Appsemble app store.
- **unlisted**: The app store page can be accessed, but the app isn’t listed publicly in the
Appsemble app store.
- **private**: The app is only visible to people who are part of the organization.
|
{"default": "unlisted", "enum": ["public", "unlisted", "private"]}
|
api.json
|
showAppDefinition
|
Whether or not people who have access to the app may see the app definition.
|
{"type": "boolean"}
|
api.json
|
locked
|
Determines whether this app should be locked from being updated.
This must be set to `false` before any other changes can be made to an app.
|
{"type": "boolean"}
|
api.json
|
template
|
Determines whether this app should be included when fetching for templates.
|
{"type": "boolean"}
|
api.json
|
longDescription
|
A long description for the app.
The long desciption will be rendered on the app details page. Markdown content is supported.
|
{"type": "string"}
|
api.json
|
screenshotUrls
|
A list of URLs referencing app screenshots
|
{"type": "array", "items": {"type": "string"}}
|
api.json
|
googleAnalyticsID
|
If this is specified, Google analytics will be applied to the app
|
{"type": "string", "pattern": "^(|UA-\\d{4,10}-\\d{1,4}|G-[\\dA-Z]{4,})$"}
|
api.json
|
sentryDsn
|
The Sentry DSN to use for this app.
If this is specified, the given Sentry DSN will be used for error tracking. Apps without a custom
domain fall back to use the Appsemble server Sentry DSN.
|
{"type": "string", "format": "url"}
|
api.json
|
sentryEnvironment
|
The name that should be used as the sentry environment.
This is only applied when `sentryDsn` is specified.
|
{"type": "string"}
|
api.json
|
AppAccount
|
An user account connected to an app
|
{"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "email": {"type": "string", "format": "email"}, "email_verified": {"type": "boolean"}, "role": {"type": "string"}, "app": {}, "sso": {"type": "array", "items": {}}, "avatar": {"type": "string", "format": "url"}}}
|
api.json
|
name
|
The name as it is available in the app.
|
{"type": "string"}
|
api.json
|
email
|
The email address as it is available in the app.
|
{"type": "string", "format": "email"}
|
api.json
|
email_verified
|
Whether this email address has been verified.
|
{"type": "boolean"}
|
api.json
|
role
|
The role of the user within the app
|
{"type": "string"}
|
api.json
|
sso
|
The single sign on configurations which link the user to an external account.
|
{"type": "array", "items": {}}
|
api.json
|
avatar
|
The URL of the avatar of the member.
|
{"type": "string", "format": "url"}
|
api.json
|
AppDefinition
|
An app definition describes what an Appsemble app looks like.
|
{"type": "object", "required": ["name", "defaultPage", "pages"], "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 1, "maxLength": 30}, "roles": {"type": "array", "items": {"type": "string"}}, "layout": {}, "notifications": {"enum": ["login", "opt-in", "startup"]}, "defaultPage": {"type": "string"}, "defaultLanguage": {"type": "string", "default": "en", "minLength": 2}, "resources": {"type": "object", "additionalProperties": {}}, "security": {}, "pages": {"type": "array", "minItems": 1, "items": {"anyOf": [{}, {}, {}, {}]}}, "theme": {}, "cron": {"type": "object", "minProperties": 1, "additionalProperties": {}}, "anchors": {"type": "array", "minItems": 1, "items": {}}}}
|
api.json
|
name
|
The human readable name of the app.
This will be displayed for example on the home screen or in the browser tab.
|
{"type": "string", "minLength": 1, "maxLength": 30}
|
api.json
|
roles
|
The list of roles that are allowed to view this app.
This list is used as the default roles for the roles property on pages and blocks, which can be
overridden by defining them for a specific page or block. Note that these roles must be defined in
`security.roles`.
|
{"type": "array", "items": {"type": "string"}}
|
api.json
|
description
|
A short description describing the app.
This will be displayed on the app store.
|
{"type": "string", "maxLength": 80}
|
api.json
|
layout
|
Properties related to the layout of the app.
|
{}
|
api.json
|
notifications
|
The strategy to use for apps to subscribe to push notifications.
If specified, push notifications can be sent to subscribed users via the _Notifications_ tab in the
app details page in Appsemble Studio. Setting this to `opt-in` allows for users to opt into
receiving push notifications by pressing the subscribe button in the App settings page. Setting this
to `startup` will cause Appsemble to immediately request for the permission upon opening the app.
If this is set to `login`, the app will request permissions for push notification once the user
logs in.
> **Note**: Setting `notifications` to `startup` is not recommended, due to its invasive nature.
|
{"enum": ["login", "opt-in", "startup"]}
|
api.json
|
defaultPage
|
The name of the page that should be displayed when the app is initially loaded.
This **must** match the name of a page defined for the app.
|
{"type": "string"}
|
api.json
|
defaultLanguage
|
The default language for the app.
|
{"type": "string", "default": "en", "minLength": 2}
|
api.json
|
resources
|
Resources define how Appsemble can store data for an app.
The most basic resource has a `schema` property and defines the minimal security rules.
|
{"type": "object", "additionalProperties": {}}
|
api.json
|
additionalProperties
|
A single resource definition.
|
{}
|
api.json
|
security
|
Role definitions that may be used by the app.
|
{}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.