Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files
xet
 Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
api.json
delete
Remove an existing email to logged in user's account.
{"tags": ["user"], "operationId": "removeEmail", "requestBody": {"required": true, "content": {"application/json": {"schema": {}}}}, "responses": {"204": {}}, "security": [{"studio": []}]}
api.json
204
The email address has been removed successfully.
{}
api.json
get
Get the accounts that have been linked to an app and the user
{"tags": ["user"], "operationId": "getAppAccounts", "security": [{"studio": []}], "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}
api.json
200
A list of linked accounts
{"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}
api.json
get
Get a single account that has been linked to an app and the current user
{"tags": ["user"], "operationId": "getAppAccount", "security": [{"studio": []}], "responses": {"200": {"content": {"application/json": {"schema": {}}}}}}
api.json
200
A list of linked accounts
{"content": {"application/json": {"schema": {}}}}
api.json
post
Register a new app account using an email address and a password.
{"tags": ["appMember"], "operationId": "registerMemberEmail", "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "required": ["email", "password", "timezone"], "properties": {"name": {"type": "string"}, "email": {"type": "string", "format": "email"}, "password": {"type": ...
api.json
requestBody
The user account to register.
{"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "required": ["email", "password", "timezone"], "properties": {"name": {"type": "string"}, "email": {"type": "string", "format": "email"}, "password": {"type": "string", "minLength": 8}, "picture": {"type": "string", "format": "binary"},...
api.json
picture
The account’s profile picture.
{"type": "string", "format": "binary"}
api.json
properties
The member’s custom properties.
{"type": "object", "additionalProperties": {"type": "string"}}
api.json
201
The account that was created.
{}
api.json
patch
Update user data for a specific app
{"tags": ["user"], "operationId": "patchAppAccount", "security": [{"studio": []}, {"app": []}], "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object", "additionalProperties": false, "properties": {"email": {"type": "string", "format": "email"}, "name": {"type": "string"}, "picture": {"type": "...
api.json
picture
The member’s profile picture.
{"type": "string", "format": "binary"}
api.json
properties
The member’s custom properties.
{"type": "object", "additionalProperties": {"type": "string"}}
api.json
locale
The preferred locale of the user.
{"type": "string"}
api.json
200
A linked app account
{"content": {"application/json": {"schema": {}}}}
api.json
post
Verify the email address of a registered user.
{"tags": ["appMember"], "operationId": "verifyMemberEmail", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["token"], "properties": {"token": {"type": "string"}}}}}}, "responses": {"200": {}}}
api.json
requestBody
The user account to register.
{"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["token"], "properties": {"token": {"type": "string"}}}}}}
api.json
200
The account was successfully verified.
{}
api.json
post
Resend the verification code for a registered email.
{"tags": ["appMember"], "operationId": "resendMemberEmailVerification", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string", "format": "email"}}}}}}, "responses": {"204": {}}, "security": [{"studio": []}, {"app"...
api.json
204
The verification email was sent if an account was found in the database.
{}
api.json
post
Request a reset token for resetting passwords.
{"tags": ["appMember"], "operationId": "requestMemberResetPassword", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string", "format": "email"}}}}}}, "responses": {"204": {}}}
api.json
204
The request has been received and an email was sent if it exists.
{}
api.json
post
Reset a password using a password reset token.
{"tags": ["appMember"], "operationId": "resetMemberPassword", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["password", "token"], "properties": {"password": {"type": "string", "minLength": 8}, "token": {"type": "string"}}}}}}, "responses": {"204": {}}}
api.json
204
The password has been reset.
{}
api.json
tags
Operations related to the App definition
{"name": "app"}
api.json
tags
Operations related to Assets
{"name": "asset"}
api.json
tags
Operations related to the Authentication
{"name": "auth"}
api.json
tags
Operations related to App translations
{"name": "language"}
api.json
tags
Operations related to organizations
{"name": "organization"}
api.json
tags
Operations related to the Resources definition
{"name": "app"}
api.json
tags
Operations related to a user.
{"name": "user"}
libman.json
files
The file names of the individual files to copy to the project.
{"type": "array", "default": null, "items": {"type": "string", "minLength": 1}}
libman.json
library
The unique identifier of the library.
{"type": "string", "minLength": 1}
libman.json
destination
The relative folder path from this config file to the location where the files should be copied to.
{"type": "string", "pattern": "^[^\\\\]+$"}
libman.json
provider
The unique identifier of the provider
{"type": "string", "minLength": 1}
libman.json
defaultProvider
The unique identifier of the provider to use as default.
{"type": "string", "minLength": 1}
libman.json
defaultDestination
The default destination to place library files.
{"type": "string", "minLength": 1}
libman.json
libraries
A list of library references.
{"type": "array", "items": {}}
libman.json
version
The syntax version of this config file. Can only be 1.0
{"enum": ["1.0"], "default": "1.0"}
typo3.json
autoUpdateSlugs
Automatically update slugs of all sub pages. Default: true
{"type": "boolean"}
typo3.json
autoCreateRedirects
Automatically create redirects for pages with a new slug (works only in LIVE workspace). Default: true
{"type": "boolean"}
typo3.json
redirectTTL
Time To Live in days for redirect records to be created - `0` disables TTL, no expiration. Default: 0
{"type": "integer"}
typo3.json
httpStatusCode
HTTP status code for the redirect, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections#Temporary_redirections. Default: 307
{"type": "integer", "anyOf": [{"type": "integer", "enum": [300, 301, 302, 303, 304, 305, 306, 307, 308]}]}
typo3.json
errorCode
Make sure to have at least 0 (not defined otherwise) configured in order to serve helpful error messages to your visitors.
{"anyOf": [{"type": "integer", "default": 404, "enum": [0, 404, 403, 500, 503]}, {"type": "integer"}]}
typo3.json
errorHandler
How to handle Errors
{"type": "string", "default": "Page", "enum": ["Page", "Fluid", "PHP"]}
typo3.json
errorPhpClassFQCN
Fully qualified class name to a class that implements the PageErrorHandlerInterface.
{"type": "string"}
typo3.json
errorFluidTemplate
Path to the fluid template file given by absolute, relative path (from site root) or by referring the template file inside an extension with "EXT:" prefix.
{"type": "string"}
typo3.json
errorContentSource
Show Content from Page
{"examples": ["t3://page?uid=123"], "type": "string"}
typo3.json
route
Static Route Name
{"type": "string"}
typo3.json
type
Route Type
{"type": "string", "enum": ["uri", "staticText"]}
typo3.json
source
Page, File or URL
{"type": "string"}
typo3.json
content
Static Text
{"type": "string"}
typo3.json
title
Title
{"type": "string"}
typo3.json
enabled
Visible in Frontend
{"type": "boolean"}
typo3.json
languageId
ID of the related sys_language record
{"type": "integer", "examples": [1]}
typo3.json
base
Use a full qualified domain "https://www.mydomain.fr/" or "/fr/". Use "/" to keep the main URL for the default language. Add language specific suffixes to use those, or configure complete URLs for independent domains.
{"type": "string", "default": "/"}
typo3.json
typo3Language
Select the language to be used from translation files. Keep default if no translation files are available. Deprecated with TYPO3 12.3
{"anyOf": [{"type": "string", "default": "default", "enum": ["default", "af", "ar", "bs", "bg", "ca", "ch", "cs", "da", "de", "el", "eo", "es", "et", "eu", "fa", "fi", "fo", "fr", "fr_CA", "gl", "he", "hi", "hr", "hu", "is", "it", "ja", "ka", "kl", "km", "ko", "lt", "lv", "mi", "mk", "ms", "nl", "no", "pl", "pt", "pt_B...
typo3.json
locale
Used for localized date and currency formats. E.g. "de_DE" or "en_US.UTF-8".
{"type": "string"}
typo3.json
iso-639-1
ISO 639-1 code of the Language
{"type": "string", "enum": ["ab", "aa", "af", "ak", "sq", "am", "ar", "an", "hy", "as", "av", "ae", "ay", "az", "bm", "ba", "eu", "be", "bn", "bh", "bi", "bs", "br", "bg", "my", "ca", "ch", "ce", "ny", "zh", "cv", "kw", "co", "cr", "hr", "cs", "da", "dv", "nl", "dz", "en", "eo", "et", "ee", "fo", "fj", "fi", "fr", "ff"...
typo3.json
navigationTitle
Used within language-related menus
{"type": "string"}
typo3.json
hreflang
Used within for "lang" and "hreflang" attributes
{"type": "string"}
typo3.json
direction
Language direction for "dir" attribute
{"type": "string", "enum": ["", "ltr", "rtl"]}
typo3.json
websiteTitle
With this language based Website title, you can override the Website title for this language
{"type": "string"}
typo3.json
fallbackType
Fallback Type
{"type": "string", "enum": ["strict", "fallback", "free"], "default": "strict"}
typo3.json
fallbacks
Fallback to other Language(s) - order is important! Comma separated list
{"type": "string"}
typo3.json
base
Base URL. This is the URL under which this site is available
{"type": "string"}
typo3.json
rootPageId
ID of the page where this site begins
{"type": "integer"}
typo3.json
websiteTitle
Default website title
{"type": "string"}
typo3.json
routeEnhancers
routeEnhancers transform arguments into nice urls. Docs can be found at https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/Routing/Index.html
{"type": "object", "additionalProperties": {"type": "object", "required": ["type"], "properties": {"type": {"type": "string", "anyOf": [{"type": "string", "enum": ["Simple", "Plugin", "Extbase", "PageType"]}, {"type": "string"}]}, "default": {"type": "string"}, "routePath": {"type": "string"}, "limitToPages": {"type": ...
typo3.json
additionalProperties
Each enhancer must have a type
{"type": "object", "required": ["type"], "properties": {"type": {"type": "string", "anyOf": [{"type": "string", "enum": ["Simple", "Plugin", "Extbase", "PageType"]}, {"type": "string"}]}, "default": {"type": "string"}, "routePath": {"type": "string"}, "limitToPages": {"type": "array", "uniqueItems": true, "items": {"ty...
typo3.json
sitePackage
Extension key for site setup (used by EXT:bolt)
{"type": "string"}
typo3.json
solr_core_read
EXT:solr default core for read
{"type": "string"}
typo3.json
solr_enabled_read
EXT:solr enable default solr read
{"type": "boolean"}
typo3.json
solr_host_read
EXT:solr default host for read
{"type": "string"}
typo3.json
solr_password_read
EXT:solr password for read
{"type": "string"}
typo3.json
solr_username_read
EXT:solr username for read
{"type": "string"}
typo3.json
solr_port_read
EXT:solr port for read
{"type": "string"}
typo3.json
solr_scheme_read
EXT:solr scheme for read
{"type": "string", "anyOf": [{"type": "string", "enum": ["http", "https", "%env(SOLR_SCHEME)%"]}]}
typo3.json
solr_use_write_connection
EXT:solr use write connection
{"type": "boolean"}
schema-store-talismanrc.json
filename
Fully qualified filename
{"type": "string"}
schema-store-talismanrc.json
checksum
This field should always have the value specified by Talisman message
{"type": "string"}
schema-store-talismanrc.json
ignore_detectors
Disable specific detectors for a particular file
{"type": "array", "items": {"type": "string", "enum": ["filecontent", "filename", "filesize"]}}
schema-store-talismanrc.json
allowed_patterns
Keywords to ignore to reduce the number of false positives
{"type": "array", "items": {"type": "string"}}
schema-store-talismanrc.json
scopeconfig
Talisman is configured to ignore certain files based on the specified scopes
{"type": "array", "items": {"type": "object", "properties": {"scope": {"type": "string"}}, "required": ["scope"]}}
schema-store-talismanrc.json
allowed_patterns
Keywords to ignore to reduce the number of false positives
{"type": "array", "items": {"type": "string"}}
schema-store-talismanrc.json
custom_patterns
You can specify custom regex patterns to look for in the current repository
{"type": "array", "items": {"type": "string"}}
schema-store-talismanrc.json
custom_severities
Custom detectors severities
{"type": "array", "items": {"type": "object", "properties": {"detector": {"type": "string"}, "severity": {"type": "string", "enum": ["low", "medium", "high"]}}, "required": ["detector", "severity"]}}
schema-store-talismanrc.json
threshold
Default minimal threshold
{"type": "string", "enum": ["low", "medium", "high"]}
schema-store-talismanrc.json
version
.talismanrc version
{"type": "string"}
values.schema.json
additionalProperties
Kontinuous component
{"type": "object", "allOf": [{"if": {"required": ["~chart"]}, "then": {}}, {"if": {"required": ["~chart"], "properties": {"~chart": {"const": "app"}}}, "then": {}}, {"if": {"required": ["~chart"], "properties": {"~chart": {"const": "jobs"}}}, "then": {}}]}
values.schema.json
then
Common to all charts
{}
values.schema.json
global
Global variables
{"type": "object", "additionalProperties": true, "properties": {"repositoryName": {"type": "string"}, "namespace": {"type": "string"}, "registry": {"type": "string", "examples": ["harbor.somewhere.io"]}, "rancherProjectId": {"type": "string", "examples": ["1234:5678"]}, "imageProject": {"type": "string", "default": "",...
values.schema.json
repositoryName
Application name, default to GIT repository name
{"type": "string"}
values.schema.json
namespace
Default namespace
{"type": "string"}
values.schema.json
registry
Default docker registry URL, it is recommended tu use .kontinuous/config.yaml file to setup registry instead of using values
{"type": "string", "examples": ["harbor.somewhere.io"]}
values.schema.json
rancherProjectId
Rancher project ID to put on the
{"type": "string", "examples": ["1234:5678"]}
values.schema.json
imageProject
Default docker project name. ex registry/[imageProject]/image:tag
{"type": "string", "default": "", "examples": ["project-x"]}
values.schema.json
imageRepository
Default docker image repository name. ex registry/project/[imageRepository]image:tag
{"type": "string", "default": "", "examples": ["application-x"]}
values.schema.json
imageTag
Default docker image repository name. ex registry/project/[imageRepository]image:tag
{"type": "string", "default": "", "examples": ["v2.3.1"]}