repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
Guts/qgis-deployment-cli | 79b8ea4f84eae27c37e38c4b6f6f0980b7054a0d | 2023-03-09T10:04:10 | docs/schemas/scenario/schema.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "Deploy and configure QGIS and related components (plugins, shortcuts, etc.).",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"metadata": {
"$ref": "metadata.json"
},
"settings": {
"$ref": "settings.json"
},
"steps": {
"$ref": "jobs/generic.json",
"description": "The steps to perform.",
"minItems": 1,
"title": "deployment steps",
"type": "array"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 8add6a83394e52044a937228429f24573d59f63e | 2023-03-09T23:21:43 | docs/schemas/profile/qgis_profile.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_profile.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alias": {
"description": "Profile's name in an human readable form, allowing special characters.",
"type": "string"
},
"author": {
"description": "Name of profile auhor and maintener.",
"type": "string"
},
"description": {
"description": "Profile description.",
"type": "string"
},
"email": {
"description": "Email of profile's auhor and maintener.",
"format": "email",
"maxLength": 127,
"minLength": 6,
"type": "string"
},
"folder_name": {
"description": "Name of the profile's directory in QGIS.",
"pattern": "^([a-zA-Z]:)?(\\\\[^<>:\"/\\\\|?*]+)+\\\\?$",
"type": "string"
},
"icon": {
"description": "Relative path to the icon used for shortcuts.",
"type": "string"
},
"name": {
"description": "Profile name without any special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$"
},
"plugins": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "qgis_plugin.json"
},
"title": "QGIS Plugins",
"type": "array"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"splash": {
"description": "Relative path to the splash image.",
"type": "string"
},
"version": {
"description": "Profile version. Must complies with SemVer.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"required": [
"author",
"email",
"name",
"version"
],
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 2cbed28f5e2711193cfeb3c3c6fc56fbcc445d84 | 2023-03-09T10:39:02 | docs/schemas/scenario/jobs/generic.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/generic.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Definition of a job, i.e. a logic execution which can be ran during a step.",
"items": {
"oneOf": [
{
"properties": {
"uses": {
"const": "manage-env-vars"
},
"with": {
"$ref": "manage-env-vars.json"
}
}
},
{
"properties": {
"uses": {
"const": "qplugins-downloader"
},
"with": {
"$ref": "qplugins-downloader.json"
}
}
},
{
"properties": {
"uses": {
"const": "qplugins-synchronizer"
},
"with": {
"$ref": "qplugins-synchronizer.json"
}
}
},
{
"properties": {
"uses": {
"const": "qprofiles-manager"
},
"with": {
"$ref": "qprofiles-manager.json"
}
}
},
{
"properties": {
"uses": {
"const": "shortcuts-manager"
},
"with": {
"$ref": "shortcuts-manager.json"
}
}
}
],
"properties": {
"name": {
"description": "Name to display and use in logs.",
"maxLength": 255,
"minLength": 1,
"title": "Job name",
"type": "string"
},
"uses": {
"description": "Which job to use.",
"enum": [
"manage-env-vars",
"qplugins-downloader",
"qplugins-synchronizer",
"qprofiles-manager",
"shortcuts-manager",
"splash-screen-manager"
],
"maxLength": 255,
"minLength": 1,
"title": "Job identifier",
"type": "string"
},
"with": {
"description": "Parameters",
"type": [
"array",
"object"
]
}
},
"required": [
"name",
"uses"
],
"type": "object"
},
"minItems": 1,
"title": "Steps",
"type": "array",
"uniqueItems": true
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 7fd4b294d0fc33f55239dbd68172cd7df35e8510 | 2024-04-05T09:09:59 | docs/schemas/scenario/jobs/qgis-installation-finder.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/jobs/qgis-installation-finder.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Job in charge of findind installed QGIS version on computer.",
"items": {
"properties": {
"if_not_found": {
"default": "warning",
"description": "Behavior if no QGIS installation found.",
"enum": [
"warning",
"error"
],
"type": "string"
},
"version_priority": {
"default": "",
"description": "Define QGIS version priority for search.",
"type": "array"
}
},
"type": "object"
},
"title": "QGIS installation finder",
"type": "array"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/scenario/schema.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "Deploy and configure QGIS and related components (plugins, shortcuts, etc.).",
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"metadata": {
"$ref": "metadata.json"
},
"settings": {
"$ref": "settings.json"
},
"steps": {
"$ref": "jobs/generic.json",
"description": "The steps to perform.",
"minItems": 1,
"title": "deployment steps",
"type": "array"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/scenario/metadata.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/metadata.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "QGIS Deployment Toolbelt - Scenario metadata",
"properties": {
"description": {
"description": "Short or long description of what this scenario does. Multilines accepted.",
"type": "string"
},
"id": {
"description": "Unique identifier of the job. Like the title but slugified and without special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$",
"type": "string"
},
"title": {
"description": "The title of the job.",
"pattern": "^[A-Za-z0-9 ]+$",
"type": "string"
}
},
"required": [
"id",
"title"
],
"title": "Define scenario's metadata.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/scenario/jobs/manage-env-vars.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/jobs/manage-env-vars.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Job in charge of setting/updating/removing environment variables on target computer.",
"items": {
"allOf": [
{
"if": {
"properties": {
"action": {
"const": "add"
}
},
"type": "object"
},
"then": {
"required": [
"value"
]
}
}
],
"properties": {
"action": {
"default": "add",
"description": "Tell the job what to do with the environment variable.",
"enum": [
"add",
"remove"
],
"type": "string"
},
"name": {
"description": "Name of the environment variable.",
"type": "string"
},
"scope": {
"default": "user",
"description": "Level of the environment variable.",
"enum": [
"user",
"system"
],
"type": "string"
},
"value": {
"description": "Value to set to the environment variable.",
"type": [
"boolean",
"string"
]
},
"value_type": {
"description": "Value type to avoid ambiguity when interpreting it.",
"enum": [
"bool",
"path",
"str",
"url"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Environment variables manager.",
"type": "array"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 8b1a993cbc7347bde51026d17fd6194aea6c4cb4 | 2023-03-10T11:27:04 | docs/schemas/scenario/jobs/shortcuts-manager.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/shortcuts-manager.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "create shortcuts in desktop and/or start menu allowing the end-user opening QGIS with a profile.",
"properties": {
"action": {
"default": "create_or_restore",
"description": "Which action to perform with shortcuts.",
"enum": [
"create",
"create_or_restore",
"remove"
],
"type": "string"
},
"include": {
"description": "Name of the branch to use when working with a git repository.",
"items": {
"properties": {
"additional_arguments": {
"description": "Arguments to pass to QGIS executable.",
"example": "--noversioncheck",
"type": "string"
},
"desktop": {
"default": false,
"description": "If true, create a desktop shortcut.",
"type": "boolean"
},
"icon": {
"description": "Filename of the icon to use for the shortcut.",
"type": "string"
},
"label": {
"description": "Text to display on the shortcut.",
"type": "string"
},
"profile": {
"description": "Name of the profile to associate with the shortcut.",
"type": "string"
},
"qgis_path": {
"deprecated": true,
"description": "Which QGIS bin/exe to use for the shortcut.",
"type": "string"
},
"start_menu": {
"default": false,
"description": "If true, create a shortcut in start menu.",
"type": "boolean"
}
},
"required": [
"label",
"profile"
],
"type": "object"
},
"type": "array"
}
},
"title": "Shortcuts Manager.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 94be5ff4815b7e08f9386bbb5a2b1beb300c9863 | 2023-02-03T16:58:55 | docs/schemas/scenario/metadata.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/metadata.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"description": "QGIS Deployment Toolbelt - Scenario metadata",
"properties": {
"description": {
"description": "Short or long description of what this scenario does. Multilines accepted.",
"type": "string"
},
"id": {
"description": "Unique identifier of the job. Like the title but slugified and without special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$",
"type": "string"
},
"title": {
"description": "The title of the job.",
"pattern": "^[A-Za-z0-9 ]+$",
"type": "string"
}
},
"required": [
"id",
"title"
],
"title": "Define scenario's metadata.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | df4087d165afd64562351930021490d1d11940ac | 2023-03-09T10:07:19 | docs/schemas/scenario/jobs/generic.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/generic.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Definition of a job, i.e. a logic execution which can be ran during a step.",
"items": {
"oneOf": [
{
"properties": {
"uses": {
"const": "manage-env-vars"
},
"with": {
"$ref": "manage-env-vars.json"
}
}
},
{
"properties": {
"uses": {
"const": "qplugins-downloader"
},
"with": {
"$ref": "qplugins-downloader.json"
}
}
},
{
"properties": {
"uses": {
"const": "qplugins-synchronizer"
},
"with": {
"$ref": "qplugins-synchronizer.json"
}
}
},
{
"properties": {
"uses": {
"const": "qprofiles-manager"
},
"with": {
"$ref": "qprofiles-manager.json"
}
}
}
],
"properties": {
"name": {
"description": "Name to display and use in logs.",
"maxLength": 255,
"minLength": 1,
"title": "Job name",
"type": "string"
},
"uses": {
"description": "Which job to use.",
"enum": [
"manage-env-vars",
"qplugins-downloader",
"qplugins-synchronizer",
"qprofiles-manager",
"shortcuts-manager",
"splash-screen-manager"
],
"maxLength": 255,
"minLength": 1,
"title": "Job identifier",
"type": "string"
},
"with": {
"description": "Parameters",
"type": [
"array",
"object"
]
}
},
"required": [
"name",
"uses"
],
"type": "object"
},
"minItems": 1,
"title": "Steps",
"type": "array",
"uniqueItems": true
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/profile/qgis_plugin.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS plugin described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/main/docs/schemas/profile/qgis_plugin.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"folder_name": {
"description": "Name of the plugins's directory once installed in QGIS. Useful when name does not complies with filename conventions.",
"pattern": "^([a-zA-Z]:)?(\\\\[^<>:\"/\\\\|?*]+)+\\\\?$",
"type": "string"
},
"location": {
"description": "Indicates if the plugin is located on a remote server or on local drive/network.",
"enum": [
"local",
"remote"
],
"type": "string"
},
"name": {
"description": "Plugin name, as referenced in the source plugins repository.",
"type": "string"
},
"official_repository": {
"description": "Indicates if the plugin is referenced on plugins.qgis.org",
"type": "boolean"
},
"plugin_id": {
"description": "Plugin ID as referenced into the repository (XML version). Typically for official repository: https://plugins.qgis.org/plugins/plugins.xml?qgis=3.22",
"type": "number"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"repository_url_xml": {
"description": "URL to the plugin repository file (XML).",
"type": "string"
},
"type": {
"deprecated": true,
"enum": [
"local",
"remote"
],
"type": "string"
},
"url": {
"description": "Direct URI (URL or local path) to download the plugin archive (.zip).",
"examples": [
"https: //plugins.qgis.org/plugins/QuickOSM/version/2.2.2/download/",
"/home/jmo/Git/Oslandia/QGIS/stsi-plugin-qgis-geocoder-locator-filter/stsi_locator_filter.1.0.0.zip"
],
"format": "uri",
"type": "string"
},
"version": {
"description": "Plugin version to install.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/scenario/settings.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/settings.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Define environment variables for the QGIS Deployment CLI execution, prefixing them with 'QDT_'. Attention, no confusion: these are the settings for the toolbelt, not for the QGIS installation.",
"properties": {
"DEBUG": {
"default": false,
"description": "Enable debug mode. Make the execution more verbose but quite slower too.",
"title": "Debug mode",
"type": "boolean"
},
"LOCAL_WORK_DIR": {
"default": null,
"description": "Where QDT stores locally everything it uses: profiles, plugins, etc.",
"title": "Local working folder.",
"type": [
"null",
"string"
]
},
"QGIS_EXE_PATH": {
"default": null,
"description": "QGIS executable to use for shortcuts and more.",
"properties": {
"linux": {
"description": "Path to QGIS on Linux.",
"examples": [
"/usr/bin/qgis"
],
"type": "string"
},
"mac": {
"description": "Path to QGIS on MacOS.",
"examples": [
"/usr/bin/qgis"
],
"type": "string"
},
"windows": {
"description": "Path to QGIS on Windows.",
"examples": [
"%PROGRAMFILES%/QGIS/3_22/bin/qgis-bin.exe"
],
"type": "string"
}
},
"title": "QGIS binary path.",
"type": "object"
},
"SCENARIO_VALIDATION": {
"default": false,
"description": "Enable scenario validation. This will check the scenario against the JSON schema.",
"title": "Scenario validation",
"type": "boolean"
}
},
"title": "QGIS Deployment Toolbelt - Environment variables",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 79b8ea4f84eae27c37e38c4b6f6f0980b7054a0d | 2023-03-09T10:04:10 | docs/schemas/profile/qgis_profile.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_profile.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alias": {
"description": "Profile's name in an human readable form, allowing special characters.",
"type": "string"
},
"author": {
"description": "Name of profile auhor and maintener.",
"type": "string"
},
"description": {
"description": "Profile description.",
"type": "string"
},
"email": {
"description": "Email of profile's auhor and maintener.",
"format": "email",
"maxLength": 127,
"minLength": 6,
"type": "string"
},
"folder_name": {
"description": "Name of the plugins's directory once installed in QGIS. Useful when name does not complies with filename conventions.",
"pattern": "^([a-zA-Z]:)?(\\\\[^<>:\"/\\\\|?*]+)+\\\\?$",
"type": "string"
},
"icon": {
"description": "Relative path to the icon used for shortcuts.",
"type": "string"
},
"name": {
"description": "Profile name without any special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$"
},
"plugins": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "qgis_plugin.json"
},
"title": "QGIS Plugins",
"type": "array"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"splash": {
"description": "Relative path to the splash image.",
"type": "string"
},
"version": {
"description": "Profile version. Must complies with SemVer.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"required": [
"author",
"email",
"name",
"version"
],
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 47adeb050ac7b707bf8b85f3e00bd1e69e7ab3cb | 2023-03-09T10:46:50 | docs/schemas/scenario/jobs/splash-screen-manager.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/splash-screen-manager.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Set your custom splash screen image.",
"properties": {
"action": {
"default": "create_or_restore",
"description": "Which action to perform with splash screen.",
"enum": [
"create",
"create_or_restore",
"remove"
],
"type": "string"
},
"strict": {
"default": false,
"description": "Check image size against QGIS recomendations: 600x300.",
"type": "boolean"
}
},
"title": "Splash Screen Manager.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 93745fb18aaa0cc94fc14011027e58ae2bb294ee | 2023-02-03T16:59:34 | docs/schemas/profile/qgis_profile.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_profile.json",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"alias": {
"description": "Profile's name in an human readable form, allowing special characters.",
"type": "string"
},
"author": {
"description": "Name of profile auhor and maintener.",
"type": "string"
},
"email": {
"format": "email",
"maxLength": 127,
"minLength": 6,
"type": "string"
},
"folder_name": {
"description": "",
"pattern": "^([a-zA-Z]:)?(\\\\[^<>:\"/\\\\|?*]+)+\\\\?$",
"type": "string"
},
"icon": {
"description": "Relative path to the icon used for shortcuts.",
"type": "string"
},
"name": {
"description": "Profile name without any special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$"
},
"plugins": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "qgis_plugin.json"
},
"minItems": 1,
"title": "QGIS Plugins",
"type": "array"
},
"qgisMaximumVersion": {
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"splash": {
"description": "Relative path to the splash image.",
"type": "string"
},
"version": {
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"required": [
"author",
"email",
"name",
"version"
],
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 07c8009ac1371eab15536c8569eafb0f1ea5d767 | 2024-03-27T13:49:29 | docs/schemas/profile/qgis_plugin.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS plugin described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/main/docs/schemas/profile/qgis_plugin.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"folder_name": {
"description": "Name of the plugins's directory once installed in QGIS. Useful when name does not complies with filename conventions.",
"type": "string"
},
"location": {
"description": "Indicates if the plugin is located on a remote server or on local drive/network.",
"enum": [
"local",
"remote"
],
"type": "string"
},
"name": {
"description": "Plugin name, as referenced in the source plugins repository.",
"type": "string"
},
"official_repository": {
"description": "Indicates if the plugin is referenced on plugins.qgis.org",
"type": "boolean"
},
"plugin_id": {
"description": "Plugin ID as referenced into the repository (XML version). Typically for official repository: https://plugins.qgis.org/plugins/plugins.xml?qgis=3.22",
"type": "number"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 3,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 3,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"repository_url_xml": {
"description": "URL to the plugin repository file (XML).",
"examples": [
"https://oslandia.gitlab.io/qgis/ngp-connect/plugins.xml"
],
"type": "string"
},
"url": {
"description": "Direct URI (URL or local path) to download the plugin archive (.zip).",
"examples": [
"https: //plugins.qgis.org/plugins/QuickOSM/version/2.2.2/download/",
"/home/jmo/Git/Oslandia/QGIS/stsi-plugin-qgis-geocoder-locator-filter/stsi_locator_filter.1.0.0.zip"
],
"format": "uri",
"type": "string"
},
"version": {
"description": "Version of the plugin to be installed.",
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 2e5c634cad7c78d357236d99a72b4f1ccce690f3 | 2023-04-14T06:17:12 | docs/schemas/profile/qgis_plugin.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_plugin.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"folder_name": {
"description": "Name of the plugins's directory once installed in QGIS. Useful when name does not complies with filename conventions.",
"pattern": "^([a-zA-Z]:)?(\\\\[^<>:\"/\\\\|?*]+)+\\\\?$",
"type": "string"
},
"location": {
"description": "Indicates if the plugin is located on a remote server or on local drive/network.",
"enum": [
"local",
"remote"
],
"type": "string"
},
"name": {
"description": "Plugin name, as referenced in the source plugins repository.",
"type": "string"
},
"official_repository": {
"description": "Indicates if the plugin is referenced on plugins.qgis.org",
"type": "boolean"
},
"plugin_id": {
"description": "Plugin ID as referenced into the repository (XML version). Typically for official repository: https://plugins.qgis.org/plugins/plugins.xml?qgis=3.22",
"type": "number"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"repository_url_xml": {
"description": "URL to the plugin repository file (XML).",
"type": "string"
},
"type": {
"deprecated": true,
"enum": [
"local",
"remote"
],
"type": "string"
},
"url": {
"description": "Direct URI (URL or local path) to download the plugin archive (.zip).",
"examples": [
"https: //plugins.qgis.org/plugins/QuickOSM/version/2.2.2/download/",
"/home/jmo/Git/Oslandia/QGIS/stsi-plugin-qgis-geocoder-locator-filter/stsi_locator_filter.1.0.0.zip"
],
"format": "uri",
"type": "string"
},
"version": {
"description": "Plugin version to install.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 810e0ff4b67b4995f8e7e15003e3f4fb6d86326b | 2023-02-06T11:58:21 | docs/schemas/scenario/schema.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "Deploy and configure QGIS and related components (plugins, shortcuts, etc.).",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"metadata": {
"$ref": "metadata.json"
},
"settings": {
"$ref": "settings.json"
},
"steps": {
"$ref": "jobs/generic.json",
"description": "The steps to perform.",
"minItems": 1,
"title": "deployment steps",
"type": "array"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 9fead974613303e098ac48110ca0a2b2a2cce648 | 2023-02-03T18:40:10 | docs/schemas/profile/qgis_profile.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_profile.json",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"alias": {
"description": "Profile's name in an human readable form, allowing special characters.",
"type": "string"
},
"author": {
"description": "Name of profile auhor and maintener.",
"type": "string"
},
"description": {
"description": "Profile description.",
"type": "string"
},
"email": {
"description": "Email of profile's auhor and maintener.",
"format": "email",
"maxLength": 127,
"minLength": 6,
"type": "string"
},
"folder_name": {
"description": "Name of the plugins's directory once installed in QGIS. Useful when name does not complies with filename conventions.",
"pattern": "^([a-zA-Z]:)?(\\\\[^<>:\"/\\\\|?*]+)+\\\\?$",
"type": "string"
},
"icon": {
"description": "Relative path to the icon used for shortcuts.",
"type": "string"
},
"name": {
"description": "Profile name without any special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$"
},
"plugins": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "qgis_plugin.json"
},
"minItems": 1,
"title": "QGIS Plugins",
"type": "array"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"splash": {
"description": "Relative path to the splash image.",
"type": "string"
},
"version": {
"description": "Profile version. Must complies with SemVer.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"required": [
"author",
"email",
"name",
"version"
],
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 2cbed28f5e2711193cfeb3c3c6fc56fbcc445d84 | 2023-03-09T10:39:02 | docs/schemas/scenario/jobs/shortcuts-manager.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/shortcuts-manager.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "create shortcuts in desktop and/or start menu allowing the end-user opening QGIS with a profile.",
"properties": {
"action": {
"default": "create_or_restore",
"deprecated": true,
"description": "Which action to perform with shortcuts.",
"enum": [
"create",
"create_or_restore",
"remove"
],
"type": "string"
},
"include": {
"description": "Name of the branch to use when working with a git repository.",
"items": {
"properties": {
"additional_arguments": {
"description": "Arguments to pass to QGIS executable.",
"example": "--noversioncheck",
"type": "string"
},
"desktop": {
"default": false,
"description": "If true, create a desktop shortcut.",
"type": "boolean"
},
"icon": {
"description": "Filename of the icon to use for the shortcut.",
"type": "string"
},
"label": {
"description": "Text to display on the shortcut.",
"type": "string"
},
"profile": {
"description": "Name of the profile to associate with the shortcut.",
"type": "string"
},
"start_menu": {
"default": false,
"description": "If true, create a shortcut in start menu.",
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
}
},
"title": "Shortcuts Manager.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/scenario/jobs/splash-screen-manager.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/jobs/splash-screen-manager.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Set your custom splash screen image.",
"properties": {
"action": {
"default": "create_or_restore",
"description": "Which action to perform with splash screen.",
"enum": [
"create",
"create_or_restore",
"remove"
],
"type": "string"
},
"strict": {
"default": false,
"description": "Check image size against QGIS recomendations: 600x300.",
"type": "boolean"
}
},
"title": "Splash Screen Manager.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 47adeb050ac7b707bf8b85f3e00bd1e69e7ab3cb | 2023-03-09T10:46:50 | docs/schemas/scenario/jobs/generic.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/generic.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Definition of a job, i.e. a logic execution which can be ran during a step.",
"items": {
"oneOf": [
{
"properties": {
"uses": {
"const": "manage-env-vars"
},
"with": {
"$ref": "manage-env-vars.json"
}
}
},
{
"properties": {
"uses": {
"const": "qplugins-downloader"
},
"with": {
"$ref": "qplugins-downloader.json"
}
}
},
{
"properties": {
"uses": {
"const": "qplugins-synchronizer"
},
"with": {
"$ref": "qplugins-synchronizer.json"
}
}
},
{
"properties": {
"uses": {
"const": "qprofiles-manager"
},
"with": {
"$ref": "qprofiles-manager.json"
}
}
},
{
"properties": {
"uses": {
"const": "shortcuts-manager"
},
"with": {
"$ref": "shortcuts-manager.json"
}
}
},
{
"properties": {
"uses": {
"const": "splash-screen-manager"
},
"with": {
"$ref": "splash-screen-manager.json"
}
}
}
],
"properties": {
"name": {
"description": "Name to display and use in logs.",
"maxLength": 255,
"minLength": 1,
"title": "Job name",
"type": "string"
},
"uses": {
"description": "Which job to use.",
"enum": [
"manage-env-vars",
"qplugins-downloader",
"qplugins-synchronizer",
"qprofiles-manager",
"shortcuts-manager",
"splash-screen-manager"
],
"maxLength": 255,
"minLength": 1,
"title": "Job identifier",
"type": "string"
},
"with": {
"description": "Parameters",
"type": [
"array",
"object"
]
}
},
"required": [
"name",
"uses"
],
"type": "object"
},
"minItems": 1,
"title": "Steps",
"type": "array",
"uniqueItems": true
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 79b8ea4f84eae27c37e38c4b6f6f0980b7054a0d | 2023-03-09T10:04:10 | docs/schemas/scenario/settings.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/settings.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Define environment variables for the QGIS Deployment CLI execution, prefixing them with 'QDT_'. Attention, no confusion: these are the settings for the toolbelt, not for the QGIS installation.",
"properties": {
"DEBUG": {
"default": false,
"description": "Enable debug mode. Make the execution more verbose but quite slower too.",
"title": "Debug mode",
"type": "boolean"
},
"LOCAL_WORK_DIR": {
"default": null,
"description": "Where QDT stores locally everything it uses: profiles, plugins, etc.",
"title": "Local working folder.",
"type": [
"null",
"string"
]
},
"QGIS_EXE_PATH": {
"default": null,
"description": "QGIS executable to use for shortcuts and more.",
"properties": {
"linux": {
"description": "Path to QGIS on Linux.",
"examples": [
"/usr/bin/qgis"
],
"type": "string"
},
"mac": {
"description": "Path to QGIS on MacOS.",
"examples": [
"/usr/bin/qgis"
],
"type": "string"
},
"windows": {
"description": "Path to QGIS on Windows.",
"examples": [
"%PROGRAMFILES%/QGIS/3_22/bin/qgis-bin.exe"
],
"type": "string"
}
},
"title": "QGIS binary path.",
"type": "object"
},
"SCENARIO_VALIDATION": {
"default": false,
"description": "Enable scenario validation. This will check the scenario against the JSON schema.",
"title": "Scenario validation",
"type": "boolean"
}
},
"title": "QGIS Deployment Toolbelt - Environment variables",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/scenario/jobs/qplugins-downloader.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/jobs/qplugins-downloader.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Download plugins into QDT local folder.",
"properties": {
"force": {
"default": false,
"description": "Controls download mode.",
"type": "boolean"
},
"threads": {
"default": 5,
"description": "Number of threads to use for downloading.",
"maximum": 5,
"minimum": 1,
"type": "integer"
}
},
"title": "QPlugins Downloader.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 79b8ea4f84eae27c37e38c4b6f6f0980b7054a0d | 2023-03-09T10:04:10 | docs/schemas/profile/qgis_plugin.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_plugin.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"location": {
"description": "Indicates if the plugin is located on a remote server or on local drive/network.",
"enum": [
"local",
"remote"
],
"type": "string"
},
"name": {
"description": "Plugin name, as referenced in the source plugins repository.",
"type": "string"
},
"official_repository": {
"description": "Indicates if the plugin is referenced on plugins.qgis.org",
"type": "boolean"
},
"plugin_id": {
"description": "Plugin ID as referenced into the repository (XML version). Typically for official repository: https://plugins.qgis.org/plugins/plugins.xml?qgis=3.22",
"type": "number"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"repository_url_xml": {
"description": "URL to the plugin repository file (XML).",
"type": "string"
},
"type": {
"deprecated": true,
"enum": [
"local",
"remote"
],
"type": "string"
},
"version": {
"description": "Plugin version to install.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
klaasnicolaas/smarty-homeassistant-config | 51b90b259aef2d9f85b1038d291a24439d7fc295 | 2022-12-27T15:44:53 | custom_components/powercalc/data/model_schema.json | 16 | 2024-05-28T03:08:46.232577Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"light",
"smart_switch",
"smart_speaker"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"prefixItems": [
{
"type": "object"
}
],
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
},
"supported_modes": {
"description": "Supported calculation modes",
"items": {
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"standby_power",
"measure_method",
"measure_device",
"supported_modes"
],
"type": "object"
} | MIT | en |
klaasnicolaas/smarty-homeassistant-config | 2598bd1b160b3c9a2de770dfa8ca7e02886e24b2 | 2023-09-09T13:12:44 | custom_components/powercalc/data/model_schema.json | 16 | 2024-05-28T03:08:46.232577Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"calculation_strategy": {
"description": "Supported calculation modes",
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"config_flow_discovery_remarks": {
"description": "Some remarks to show in the GUI config flow on first step of discovery",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"camera",
"light",
"smart_switch",
"smart_speaker",
"network"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"items": {
"properties": {
"attribute": {
"type": "string"
},
"integration": {
"type": "string"
},
"map": {
"type": "object"
},
"pattern": {
"type": "string"
},
"profile": {
"type": "string"
},
"type": {
"enum": [
"attribute",
"entity_id",
"entity_state",
"integration"
]
}
},
"required": [
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
}
},
"required": [
"name",
"measure_method",
"measure_device",
"calculation_strategy"
],
"type": "object"
} | MIT | en |
klaasnicolaas/smarty-homeassistant-config | bd082119d2427b3dd81b0a8925268056180e2f1d | 2023-01-15T13:01:57 | custom_components/powercalc/data/model_schema.json | 16 | 2024-05-28T03:08:46.232577Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"calculation_strategy": {
"description": "Supported calculation modes",
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"config_flow_discovery_remarks": {
"description": "Some remarks to show in the GUI config flow on first step of discovery",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"light",
"smart_switch",
"smart_speaker"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"prefixItems": [
{
"type": "object"
}
],
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
}
},
"required": [
"name",
"standby_power",
"measure_method",
"measure_device",
"calculation_strategy"
],
"type": "object"
} | MIT | en |
klaasnicolaas/Student-homeassistant-config | f6a5588bf9591fcc23a568759a768b6a680b7307 | 2022-12-19T14:09:08 | custom_components/powercalc/data/model_schema.json | 211 | 2024-05-29T11:18:42.162737Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"light",
"smart_switch",
"smart_speaker"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"prefixItems": [
{
"type": "object"
}
],
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
},
"supported_modes": {
"description": "Supported calculation modes",
"items": {
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"standby_power",
"measure_method",
"measure_device",
"supported_modes"
],
"type": "object"
} | MIT | en |
klaasnicolaas/Student-homeassistant-config | 18a7e7c424ce36009af276f4c82a37e7f8d727bb | 2023-06-22T10:07:23 | custom_components/powercalc/data/model_schema.json | 211 | 2024-05-29T11:18:42.162737Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"calculation_strategy": {
"description": "Supported calculation modes",
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"config_flow_discovery_remarks": {
"description": "Some remarks to show in the GUI config flow on first step of discovery",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"light",
"smart_switch",
"smart_speaker"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"items": {
"properties": {
"attribute": {
"type": "string"
},
"integration": {
"type": "string"
},
"map": {
"type": "object"
},
"pattern": {
"type": "string"
},
"profile": {
"type": "string"
},
"type": {
"enum": [
"attribute",
"entity_id",
"entity_state",
"integration"
]
}
},
"required": [
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
}
},
"required": [
"name",
"standby_power",
"measure_method",
"measure_device",
"calculation_strategy"
],
"type": "object"
} | MIT | en |
klaasnicolaas/Student-homeassistant-config | ebe6c49fa66668338dd69825e326071fb26ba5bb | 2023-11-23T00:03:17 | custom_components/powercalc/data/model_schema.json | 211 | 2024-05-29T11:18:42.162737Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"calculation_strategy": {
"description": "Supported calculation modes",
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"config_flow_discovery_remarks": {
"description": "Some remarks to show in the GUI config flow on first step of discovery",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"camera",
"light",
"smart_switch",
"smart_speaker",
"network"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"items": {
"properties": {
"attribute": {
"type": "string"
},
"integration": {
"type": "string"
},
"map": {
"type": "object"
},
"pattern": {
"type": "string"
},
"profile": {
"type": "string"
},
"type": {
"enum": [
"attribute",
"entity_id",
"entity_state",
"integration"
]
}
},
"required": [
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
}
},
"required": [
"name",
"measure_method",
"measure_device",
"calculation_strategy"
],
"type": "object"
} | MIT | en |
klaasnicolaas/Student-homeassistant-config | 8bdefc3ac4cd64d5b8a324d3a1b23a51dcc85a34 | 2023-02-08T00:08:56 | custom_components/powercalc/data/model_schema.json | 211 | 2024-05-29T11:18:42.162737Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"calculation_strategy": {
"description": "Supported calculation modes",
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"config_flow_discovery_remarks": {
"description": "Some remarks to show in the GUI config flow on first step of discovery",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"light",
"smart_switch",
"smart_speaker"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"prefixItems": [
{
"type": "object"
}
],
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
}
},
"required": [
"name",
"standby_power",
"measure_method",
"measure_device",
"calculation_strategy"
],
"type": "object"
} | MIT | en |
klaasnicolaas/Student-homeassistant-config | 6c113833d644665a0d8b380032e41cab8c548870 | 2023-06-14T21:32:02 | custom_components/powercalc/data/model_schema.json | 211 | 2024-05-29T11:18:42.162737Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"calculation_strategy": {
"description": "Supported calculation modes",
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"config_flow_discovery_remarks": {
"description": "Some remarks to show in the GUI config flow on first step of discovery",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"light",
"smart_switch",
"smart_speaker"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"items": {
"properties": {
"attribute": {
"type": "string"
},
"map": {
"type": "object"
},
"pattern": {
"type": "string"
},
"profile": {
"type": "string"
},
"type": {
"enum": [
"attribute",
"entity_id",
"entity_state"
]
}
},
"required": [
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
}
},
"required": [
"name",
"standby_power",
"measure_method",
"measure_device",
"calculation_strategy"
],
"type": "object"
} | MIT | en |
klaasnicolaas/Student-homeassistant-config | 4643af25ea605c126d826e3d39a8a4c1fa5cc0f0 | 2023-07-30T17:54:20 | custom_components/powercalc/data/model_schema.json | 211 | 2024-05-29T11:18:42.162737Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"calculation_strategy": {
"description": "Supported calculation modes",
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"config_flow_discovery_remarks": {
"description": "Some remarks to show in the GUI config flow on first step of discovery",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"light",
"smart_switch",
"smart_speaker",
"network"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"items": {
"properties": {
"attribute": {
"type": "string"
},
"integration": {
"type": "string"
},
"map": {
"type": "object"
},
"pattern": {
"type": "string"
},
"profile": {
"type": "string"
},
"type": {
"enum": [
"attribute",
"entity_id",
"entity_state",
"integration"
]
}
},
"required": [
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
}
},
"required": [
"name",
"measure_method",
"measure_device",
"calculation_strategy"
],
"type": "object"
} | MIT | en |
SlavaVedernikov/C4InterFlow | bb6d022f3856c7a681b63360b0fb7631613c9bc4 | 2024-02-28T17:29:56 | Schemas/structures-schema.json | 18 | 2024-05-27T06:37:17.576488Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {
"properties": {
"SoftwareSystems": {
"additionalProperties": {
"$ref": "#/definitions/SoftwareSystem"
},
"type": "object"
}
},
"type": "object"
},
"definitions": {
"Container": {
"properties": {
"ContainerType": {
"anyOf": [
{
"enum": [
"Api",
"Database",
"ServerConsole",
"Queue",
"ClientDesktop",
"WebApplication",
"FileSystem",
"ServerlessFunction"
],
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"Interfaces": {
"additionalProperties": {
"$ref": "#/definitions/Interface"
},
"type": "object"
}
},
"type": "object"
},
"Flow.Catch": {
"properties": {
"Expression": {
"type": "string"
},
"Flows": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/Flow.Use"
},
{
"$ref": "#/definitions/Flow.If"
},
{
"$ref": "#/definitions/Flow.Loop"
},
{
"$ref": "#/definitions/Flow.Group"
},
{
"$ref": "#/definitions/Flow.Try"
},
{
"$ref": "#/definitions/Flow.ThrowException"
},
{
"$ref": "#/definitions/Flow.Return"
}
]
},
"type": "array"
},
"Type": {
"enum": [
"Catch"
],
"type": "string"
}
},
"type": "object"
},
"Flow.Else": {
"properties": {
"Flows": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/Flow.Use"
},
{
"$ref": "#/definitions/Flow.If"
},
{
"$ref": "#/definitions/Flow.Loop"
},
{
"$ref": "#/definitions/Flow.Group"
},
{
"$ref": "#/definitions/Flow.Finally"
},
{
"$ref": "#/definitions/Flow.ThrowException"
},
{
"$ref": "#/definitions/Flow.Return"
}
]
},
"type": "array"
},
"Type": {
"enum": [
"Else"
],
"type": "string"
}
},
"type": "object"
},
"Flow.ElseIf": {
"properties": {
"Expression": {
"type": "string"
},
"Flows": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/Flow.Use"
},
{
"$ref": "#/definitions/Flow.If"
},
{
"$ref": "#/definitions/Flow.Loop"
},
{
"$ref": "#/definitions/Flow.Group"
},
{
"$ref": "#/definitions/Flow.Try"
},
{
"$ref": "#/definitions/Flow.ThrowException"
},
{
"$ref": "#/definitions/Flow.Return"
}
]
},
"type": "array"
},
"Type": {
"enum": [
"ElseIf"
],
"type": "string"
}
},
"type": "object"
},
"Flow.Finally": {
"properties": {
"Flows": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/Flow.Use"
},
{
"$ref": "#/definitions/Flow.If"
},
{
"$ref": "#/definitions/Flow.Loop"
},
{
"$ref": "#/definitions/Flow.Group"
},
{
"$ref": "#/definitions/Flow.Try"
},
{
"$ref": "#/definitions/Flow.ThrowException"
},
{
"$ref": "#/definitions/Flow.Return"
}
]
},
"type": "array"
},
"Type": {
"enum": [
"Finally"
],
"type": "string"
}
},
"type": "object"
},
"Flow.Group": {
"properties": {
"Expression": {
"type": "string"
},
"Flows": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/Flow.Use"
},
{
"$ref": "#/definitions/Flow.If"
},
{
"$ref": "#/definitions/Flow.Loop"
},
{
"$ref": "#/definitions/Flow.Group"
},
{
"$ref": "#/definitions/Flow.Try"
},
{
"$ref": "#/definitions/Flow.ThrowException"
},
{
"$ref": "#/definitions/Flow.Return"
}
]
},
"type": "array"
},
"Type": {
"enum": [
"Group"
],
"type": "string"
}
},
"type": "object"
},
"Flow.If": {
"properties": {
"Expression": {
"type": "string"
},
"Flows": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/Flow.Use"
},
{
"$ref": "#/definitions/Flow.If"
},
{
"$ref": "#/definitions/Flow.ElseIf"
},
{
"$ref": "#/definitions/Flow.Else"
},
{
"$ref": "#/definitions/Flow.Loop"
},
{
"$ref": "#/definitions/Flow.Group"
},
{
"$ref": "#/definitions/Flow.Try"
},
{
"$ref": "#/definitions/Flow.ThrowException"
},
{
"$ref": "#/definitions/Flow.Return"
}
]
},
"type": "array"
},
"Type": {
"enum": [
"If"
],
"type": "string"
}
},
"type": "object"
},
"Flow.Loop": {
"properties": {
"Expression": {
"type": "string"
},
"Flows": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/Flow.Use"
},
{
"$ref": "#/definitions/Flow.If"
},
{
"$ref": "#/definitions/Flow.Loop"
},
{
"$ref": "#/definitions/Flow.Group"
},
{
"$ref": "#/definitions/Flow.Try"
},
{
"$ref": "#/definitions/Flow.ThrowException"
},
{
"$ref": "#/definitions/Flow.Return"
}
]
},
"type": "array"
},
"Type": {
"enum": [
"Loop"
],
"type": "string"
}
},
"type": "object"
},
"Flow.None": {
"properties": {
"Flows": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/Flow.Use"
},
{
"$ref": "#/definitions/Flow.If"
},
{
"$ref": "#/definitions/Flow.Loop"
},
{
"$ref": "#/definitions/Flow.Group"
},
{
"$ref": "#/definitions/Flow.Try"
},
{
"$ref": "#/definitions/Flow.ThrowException"
},
{
"$ref": "#/definitions/Flow.Return"
}
]
},
"type": "array"
},
"Type": {
"enum": [
"None"
],
"type": "string"
}
},
"type": "object"
},
"Flow.Return": {
"properties": {
"Expression": {
"type": "string"
},
"Type": {
"enum": [
"Return"
],
"type": "string"
}
},
"type": "object"
},
"Flow.ThrowException": {
"properties": {
"Expression": {
"type": "string"
},
"Type": {
"enum": [
"ThrowException"
],
"type": "string"
}
},
"type": "object"
},
"Flow.Try": {
"properties": {
"Flows": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/Flow.Use"
},
{
"$ref": "#/definitions/Flow.If"
},
{
"$ref": "#/definitions/Flow.Loop"
},
{
"$ref": "#/definitions/Flow.Group"
},
{
"$ref": "#/definitions/Flow.Try"
},
{
"$ref": "#/definitions/Flow.Catch"
},
{
"$ref": "#/definitions/Flow.Finally"
},
{
"$ref": "#/definitions/Flow.ThrowException"
},
{
"$ref": "#/definitions/Flow.Return"
}
]
},
"type": "array"
},
"Type": {
"enum": [
"Try"
],
"type": "string"
}
},
"type": "object"
},
"Flow.Use": {
"properties": {
"Expression": {
"$ref": "#/definitions/Interfaces"
},
"Type": {
"enum": [
"Use"
],
"type": "string"
}
},
"type": "object"
},
"Interface": {
"properties": {
"Flow": {
"$ref": "#/definitions/Flow.None"
}
},
"type": "object"
},
"Interfaces": {
"enum": [
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendProductPriceChangedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendPurchaseOrderCreatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendItemReleasedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendConsignmentCreatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendConsignmentReceiptedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendCreateMissingItemEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendCreateItemEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendCustomsEntryCreatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendReturnToVendorCreatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendReturnToVendorStatusUpdatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendReturnToVendorReleasedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendReturnToVendorShippedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendReturnToVendorCompletedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendSalesOrderCreatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendSalesOrderCancelledEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendSalesOrderStatusUpdatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendPaymentFailedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendPaymentStatusUpdatedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendSalesOrderShippedEvent",
"Matches.SoftwareSystems.AWSEventBridge.Interfaces.SendOrderDocumentsRequestedEvent",
"Matches.SoftwareSystems.AWSSimpleEmailService.Interfaces.SendEmail",
"Matches.SoftwareSystems.DataDog.Interfaces.SendPricingError",
"Matches.SoftwareSystems.DataDog.Interfaces.ReceivePricingError",
"Matches.SoftwareSystems.ECourier.Interfaces.CreateOrder",
"Matches.SoftwareSystems.ECourier.Interfaces.UpdateOrder",
"Matches.SoftwareSystems.ODS.Interfaces.SelectRMIsByCustomerNumber",
"Matches.SoftwareSystems.ODS.Interfaces.SelectOrderHistoryByCustomerURN",
"Matches.SoftwareSystems.ODS.Interfaces.SelectRMIsByOrderNumberAndCustomerNumber",
"Matches.SoftwareSystems.ODS.Interfaces.SelectOrderHistoryByOrderRefAndCustomerURN",
"Matches.SoftwareSystems.ODS.Interfaces.SelectProductsByBarcode",
"Matches.SoftwareSystems.ODS.Interfaces.SelectProductByProductItemId",
"Matches.SoftwareSystems.PayPal.Interfaces.CapturePayment",
"Matches.SoftwareSystems.SessionM.Interfaces.SpendUserPoints",
"Matches.SoftwareSystems.SessionM.Interfaces.SendTransaction",
"Matches.SoftwareSystems.Slack.Interfaces.SendPriceAlertNotification",
"Matches.SoftwareSystems.Slack.Interfaces.ReceivePriceAlertNotification",
"Matches.SoftwareSystems.SMTPServer.Interfaces.SendGDPRCoordinatorRemindernotificationEmail",
"Matches.SoftwareSystems.SMTPServer.Interfaces.SendGDPRCoordinatorNotificationEmail",
"Matches.SoftwareSystems.SMTPServer.Interfaces.SendGDPRCoordinatorErrorNotificationEmail",
"Matches.SoftwareSystems.Stripe.Interfaces.CapturePayment",
"Matches.SoftwareSystems.Accertify.Containers.API.Interfaces.CreateOrder",
"Matches.SoftwareSystems.Accertify.Containers.API.Interfaces.UpdateOrderFraudStatus",
"Matches.SoftwareSystems.Accertify.Containers.UI.Interfaces.UpdateOrderFraudStatus",
"Matches.SoftwareSystems.BuyersApp.Containers.API.Interfaces.PublishPurchaseOrder",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectCurrencies",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectColours",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectSeasons",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectSizes",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectLocations",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectCountries",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectShipmentMethods",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectPaymentTerms",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectSlugCodes",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectItemDutyRates",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectBrandVendors",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectCategories",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectCurrencyFactors",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectBMGroups",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.SelectPurchaseOrder",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateCurrencies",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateColours",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateSeasons",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateSizes",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateLocations",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateCountries",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateShipmentMethods",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdatePaymentTerms",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateSlugCodes",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateItemDutyRates",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateBrandVendors",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateCategories",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateCurrencyFactors",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdateBMGroups",
"Matches.SoftwareSystems.BuyersApp.Containers.Database.Interfaces.InsertAndUpdatePurchaseOrder",
"Matches.SoftwareSystems.BuyersApp.Containers.RealmDB.Interfaces.InsertAndUpdatePurchaseOrder",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncCurrenciesJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncColoursJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncSeasonsJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncSizesJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncLocationsJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncCountriesJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncShipmentMethodsJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncPaymentTermsJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncSlugCodesJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncItemDutyRatesJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncBrandVendorsJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncCategoriesJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncCurrencyFactorsJob",
"Matches.SoftwareSystems.BuyersApp.Containers.ScheduledJobs.Interfaces.RunSyncBMGroupsJob",
"Matches.SoftwareSystems.BuyersApp.Containers.UI.Interfaces.PublishPurchaseOrder",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.API.Interfaces.CreateConsignment",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.API.Interfaces.CreateReturnToVendor",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.Database.Interfaces.InsertConsignmentRecord",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.Database.Interfaces.UpdateConsignmentRecord",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.Database.Interfaces.InsertReturnToVendorRecord",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.Database.Interfaces.UpdateReturnToVendorStatus",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.Database.Interfaces.SetReturnToVendorAsCompleted",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQS.Interfaces.SendConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQS.Interfaces.ReceiveConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQS.Interfaces.SendConsignmentReceiptedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQS.Interfaces.ReceiveConsignmentReceiptedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQS.Interfaces.SendReturnToVendorStatusUpdatedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQS.Interfaces.ReceiveReturnToVendorStatusUpdatedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQS.Interfaces.SendReturnToVendorCompletedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQS.Interfaces.ReceiveReturnToVendorCompletedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQSHandlers.Interfaces.HandleConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQSHandlers.Interfaces.HandleConsignmentReceiptedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQSHandlers.Interfaces.HandleReturnToVendorStatusUpdatedEvent",
"Matches.SoftwareSystems.ConcessionsPlatform.Containers.SQSHandlers.Interfaces.HandleReturnToVendorCompletedEvent",
"Matches.SoftwareSystems.DataPlatform.Containers.Database.Interfaces.InsertPaymentStatusUpdatedEvent",
"Matches.SoftwareSystems.DataPlatform.Containers.GDPRDatabase.Interfaces.ExecuteCreateGDPRRequestStoredProcedure",
"Matches.SoftwareSystems.DataPlatform.Containers.SQS.Interfaces.SendPaymentStatusUpdatedEvent",
"Matches.SoftwareSystems.DataPlatform.Containers.SQS.Interfaces.ReceivePaymentStatusUpdatedEvent",
"Matches.SoftwareSystems.DataPlatform.Containers.SQSHandlers.Interfaces.HandlePaymentStatusUpdatedEvent",
"Matches.SoftwareSystems.EmbellishmentApp.Containers.App.Interfaces.UpdateProductData",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.API.Interfaces.SendIndividualIDRInitialisations",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.API.Interfaces.SendIndividualIDRCompletions",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.API.Interfaces.SendIndividualInitialisation",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.API.Interfaces.PostGDPRRequestAcknowledgements",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.API.Interfaces.SendIndividualCompletions",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.API.Interfaces.GDPRAcknowledgeCompletion",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.API.Interfaces.UpdateRTBFStatus",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.API.Interfaces.UpdateIDRStatus",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.ResetCountOfRequests",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.ResetCountOfIDRRequests",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.FindRequestsinIDRQueue",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.CountRequestsinIDRQueue",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.SelectCountOfIDRRequests",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.InsertIntoIDRQueue",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.SelectNotCompletedRequestsfromRTBFAuditLog",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.FindDataRequestById",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.UpdateRequestCount",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.SaveDataRequest",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.AddLogEntry",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.UpdateDataRequest",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.DeleteFromIDRQueueById",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Database.Interfaces.UpdateIDRRequestCount",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.ScheduledJobs.Interfaces.RunCounterJob",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.ScheduledJobs.Interfaces.RunProcessIDRRequestsJob",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.ScheduledJobs.Interfaces.RunSalesForceIDRCompleteJob",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.ScheduledJobs.Interfaces.RunSalesForceIDRPullJob",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.ScheduledJobs.Interfaces.RunSalesForcePullJob",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.ScheduledJobs.Interfaces.SendIndividualInitialisation",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.ScheduledJobs.Interfaces.RunReminderJob",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.ScheduledJobs.Interfaces.RunSalesForceRTBFCompleteJob",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.ScheduledJobs.Interfaces.SendIndividualCompletions",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.TriggerNextRTBFAction",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.SendRTBFToHybris",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.SendRTBFToNAV",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.SendRTBFToBI",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.SendRTBFToSalesForce",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.CompleteRTBFRequest",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.HashCustomerEmailAddress",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.TriggerNextIDRAction",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.SendIDRToHybris",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.SendIDRToNAV",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.SendIDRToBI",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.SendIDRToSalesForce",
"Matches.SoftwareSystems.GDPRCoordinatorApp.Containers.Workflow.Interfaces.CompleteIDRRequest",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.UpdateCustomerOrderRiskStatus",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.UpdateCustomerOrderFraudStatus",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.CancelCustomerOrder",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.GetCustomerOrderById",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.GetReturnRequestById",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.CreateAddress",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.GetCustomerById",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.CreateCustomer",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.RefundOrder",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.SearchProducts",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.GetProductByRef",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.GetProductVariantByRef",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.GetDesignerByRef",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.GetSeasonByRef",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.GetGarmentTypeByRef",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.GetProductFacets",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.SendRTBFRequest",
"Matches.SoftwareSystems.Hybris.Containers.API.Interfaces.SendIDRRequest",
"Matches.SoftwareSystems.Hybris.Containers.App.Interfaces.GetPrices",
"Matches.SoftwareSystems.Hybris.Containers.App.Interfaces.UpdateCustomerOrder",
"Matches.SoftwareSystems.Hybris.Containers.App.Interfaces.CancelCustomerOrder",
"Matches.SoftwareSystems.Hybris.Containers.CommonLibrary.Interfaces.CreateAddress",
"Matches.SoftwareSystems.Hybris.Containers.CommonLibrary.Interfaces.SearchCustomers",
"Matches.SoftwareSystems.Hybris.Containers.CommonLibrary.Interfaces.GetCustomerById",
"Matches.SoftwareSystems.Hybris.Containers.CommonLibrary.Interfaces.CreateCustomer",
"Matches.SoftwareSystems.Hybris.Containers.CommonLibrary.Interfaces.RefundOrder",
"Matches.SoftwareSystems.Hybris.Containers.CommonLibrary.Interfaces.GetProductByRef",
"Matches.SoftwareSystems.Hybris.Containers.CommonLibrary.Interfaces.GetProductByBarcode",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.SelectTaxes",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.SelectCountries",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.SelectCurrencies",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.InsertItem",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.InsertCustomerOrder",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.UpdateCustomerOrderRiskStatus",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.UpdateCustomerOrderFraudStatus",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.UpdateCustomerOrder",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.CancelCustomerOrder",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.UpdateCustomerOrderStatus",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.SetCustomerOrderToShipped",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.UpdateProductPrice",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.SelectReturnRequestById",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.SelectCustomerOrders",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.InsertAddress",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.SelectCustomers",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.SelectCustomer",
"Matches.SoftwareSystems.Hybris.Containers.Database.Interfaces.InsertCustomer",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.GetCustomerProfile",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.GetCustomerBenefits",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.GetCustomerOffers",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.GetCustomerDOB",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.GetCustomerOptin",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PostCustomerProfile",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PostCustomerBenefits",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PostCustomerOffers",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PostCustomerDOB",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PostCustomerOptin",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PutCustomerProfile",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PutCustomerBenefits",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PutCustomerOffers",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PutCustomerDOB",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PutCustomerOptin",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PatchCustomerProfile",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PatchCustomerBenefits",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PatchCustomerOffers",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PatchCustomerDOB",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.PatchCustomerOptin",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.DeleteCustomerProfile",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.DeleteCustomerBenefits",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.DeleteCustomerOffers",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.DeleteCustomerDOB",
"Matches.SoftwareSystems.Hybris.Containers.LoyaltyAPI.Interfaces.DeleteCustomerOptin",
"Matches.SoftwareSystems.Hybris.Containers.ScheduledJobs.Interfaces.RunImportReleasedItemsJob",
"Matches.SoftwareSystems.Hybris.Containers.ScheduledJobs.Interfaces.RunImportSalesOrderStatusUpdatesJob",
"Matches.SoftwareSystems.Hybris.Containers.ScheduledJobs.Interfaces.RunImportShippedSalesOrdersJob",
"Matches.SoftwareSystems.Hybris.Containers.ScheduledJobs.Interfaces.RunImportProductPriceChangesJob",
"Matches.SoftwareSystems.Hybris.Containers.SQS.Interfaces.SendItemReleasedEvent",
"Matches.SoftwareSystems.Hybris.Containers.SQS.Interfaces.ReceiveItemReleasedEvent",
"Matches.SoftwareSystems.Hybris.Containers.SQS.Interfaces.SendSalesOrderStatusUpdatedEvent",
"Matches.SoftwareSystems.Hybris.Containers.SQS.Interfaces.ReceiveSalesOrderStatusUpdatedEvent",
"Matches.SoftwareSystems.Hybris.Containers.SQS.Interfaces.SendSalesOrderShippedEvent",
"Matches.SoftwareSystems.Hybris.Containers.SQS.Interfaces.ReceiveSalesOrderShippedEvent",
"Matches.SoftwareSystems.Hybris.Containers.SQS.Interfaces.SendProductPriceChangedEvent",
"Matches.SoftwareSystems.Hybris.Containers.SQS.Interfaces.ReceiveProductPriceChangedEvent",
"Matches.SoftwareSystems.Hybris.Containers.Web.Interfaces.CreateCustomerOrder",
"Matches.SoftwareSystems.Hybris.Containers.Web.Interfaces.UpdateCustomerOrder",
"Matches.SoftwareSystems.Hybris.Containers.Web.Interfaces.CancelCustomerOrder",
"Matches.SoftwareSystems.Kering.Containers.Kafka.Interfaces.SendInboundDelivery",
"Matches.SoftwareSystems.Kering.Containers.Kafka.Interfaces.ReceiveInboundDelivery",
"Matches.SoftwareSystems.Kering.Containers.Kafka.Interfaces.SendOutboundDelivery",
"Matches.SoftwareSystems.Kering.Containers.Kafka.Interfaces.ReceiveOutboundDelivery",
"Matches.SoftwareSystems.Kering.Containers.Kafka.Interfaces.SendConsignmentReceiptedEvent",
"Matches.SoftwareSystems.Kering.Containers.Kafka.Interfaces.ReceiveConsignmentReceiptedEvent",
"Matches.SoftwareSystems.Kering.Containers.Kafka.Interfaces.SendOrderEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.Database.Interfaces.InsertInboundDeliveryMessage",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.Database.Interfaces.InsertConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.Database.Interfaces.InsertConsignmentReceiptedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.Database.Interfaces.InsertOutboundDeliveryMessage",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.SendInboundDelivery",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.ReceiveInboundDelivery",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.SendOutboundDelivery",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.ReceiveOutboundDelivery",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.SendConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.ReceiveConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.SendConsignmentReceiptedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.ReceiveConsignmentReceiptedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.SendReturnToVendorCompletedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQS.Interfaces.ReceiveReturnToVendorCompletedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQSHandlers.Interfaces.HandleInboundDeliveryMessage",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQSHandlers.Interfaces.HandleOutboundDeliveryMessage",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQSHandlers.Interfaces.HandleConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.SQSHandlers.Interfaces.HandleConsignmentReceiptedEvent",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.TransportAdapter.Interfaces.ReceiveInboundDelivery",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.TransportAdapter.Interfaces.ReceiveOutboundDelivery",
"Matches.SoftwareSystems.KeringConcessionsPlatform.Containers.TransportAdapter.Interfaces.HandleReturnToVendorCompletedEvent",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.CreateCustomerAddress",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetCustomers",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetCustomerById",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetCustomerCredits",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.CreateCustomer",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.CreateTransaction",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.SpendPoints",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.CreateDeliveries",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.UpdateDeliveryStatus",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.SendReceipt",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetLookbookRequests",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.CreateLookbookRequest",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetLookbookRequestById",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetCustomerOrdersByCustomerRef",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetCustomerOrderByOrderIdAndCustomerRef",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.CreateCustomerOrder",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetCustomerOrderByOrderId",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetPOSConfiguration",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetAllPointsOfSale",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.CreatePointOfSale",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetPointOfSaleById",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetProductById",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetProductsByBarcode",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetStockByProductIdAndSKUCode",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetTransactions",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.CreateTransactions",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetUsers",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetUserById",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.CreateUser",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetCategories",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetCountries",
"Matches.SoftwareSystems.MatchesAPI.Containers.API.Interfaces.GetCurrencies",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.FindLookbookRequests",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.CreateLookbookRequest",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.FindOneLookbookRequest",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.FindPointsOfSale",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.CreatePointOfSale",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.FindOnePointOfSale",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.FindTransactions",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.CreateTransactions",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.FindUsers",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.FindUserById",
"Matches.SoftwareSystems.MatchesAPI.Containers.Database.Interfaces.CreateUser",
"Matches.SoftwareSystems.MatchesAPI.Containers.FileSystemStorage.Interfaces.ReadPOSDataCongigJSONFile",
"Matches.SoftwareSystems.MatchesAPI.Containers.FileSystemStorage.Interfaces.ReadCategoryCatalogueJSONFile",
"Matches.SoftwareSystems.MatchesAPI.Containers.FileSystemStorage.Interfaces.ReadCountriesListJSONFile",
"Matches.SoftwareSystems.MatchesAPI.Containers.FileSystemStorage.Interfaces.ReadCurrenciesXMLFiles",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.GetCustomerProfile",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.GetCustomerBenefits",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.GetCustomerOffers",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.GetCustomerDOB",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.GetCustomerOptin",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PostCustomerProfile",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PostCustomerBenefits",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PostCustomerOffers",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PostCustomerDOB",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PostCustomerOptin",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PutCustomerProfile",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PutCustomerBenefits",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PutCustomerOffers",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PutCustomerDOB",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PutCustomerOptin",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PatchCustomerProfile",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PatchCustomerBenefits",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PatchCustomerOffers",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PatchCustomerDOB",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.PatchCustomerOptin",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.DeleteCustomerProfile",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.DeleteCustomerBenefits",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.DeleteCustomerOffers",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.DeleteCustomerDOB",
"Matches.SoftwareSystems.MatchesAPI.Containers.LoyaltyAPI.Interfaces.DeleteCustomerOptin",
"Matches.SoftwareSystems.MaxMaraAndNewConcessionBrands.Containers.API.Interfaces.SendConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.MaxMaraAndNewConcessionBrands.Containers.API.Interfaces.SendConsignmentReceiptedEvent",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetCurrencies",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetColours",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSeasons",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSizes",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetLocations",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetCountries",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetShipmentMethods",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetPaymentTerms",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSlugCodes",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetItemDutyRates",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetBrandVendors",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetCategories",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetCurrencyFactors",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetBMGroups",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.CreateSalesOrder",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.UpdateSalesOrderRiskStatus",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.UpdateSalesOrderFraudStatus",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.UpdateSalesOrder",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.CancelSalesOrder",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrdersByCustomerEmail",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrderById",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrderLines",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrderHistory",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrderReturns",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrderReturnLines",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrderReturnHistory",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrderComments",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.PostSalesOrderComments",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetPaymentsBySalesOrderId",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.SendCourierCollectionRequest",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.SendCourierDeliveryRequest",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetECourierFailures",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetCustomerCredits",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.LoadInternetECourierStatusUpdate",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrdersByCustomerNumber",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetSalesOrderByOrderReferenceAndCustomerNumber",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetInventoryByItemNumberAndSKUCode",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetProductStock",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.GetProductById",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.SendRTBFRequest",
"Matches.SoftwareSystems.NAV.Containers.API.Interfaces.SendIDRRequest",
"Matches.SoftwareSystems.NAV.Containers.CommonLibrary.Interfaces.PostOrderComment",
"Matches.SoftwareSystems.NAV.Containers.CommonLibrary.Interfaces.GetSalesOrderById",
"Matches.SoftwareSystems.NAV.Containers.CommonLibrary.Interfaces.GetSalesOrderLines",
"Matches.SoftwareSystems.NAV.Containers.CommonLibrary.Interfaces.GetSalesOrderHistory",
"Matches.SoftwareSystems.NAV.Containers.CommonLibrary.Interfaces.GetProductVariantByBarcode",
"Matches.SoftwareSystems.NAV.Containers.CommonLibrary.Interfaces.GetProductStock",
"Matches.SoftwareSystems.NAV.Containers.CommonLibrary.Interfaces.GetProductById",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectPrices",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectCurrencies",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectColours",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSeasons",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSizes",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectLocations",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectCountries",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectShipmentMethods",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectPaymentTerms",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSlugCodes",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectItemDutyRates",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectProductTaxData",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectBrandVendors",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectCategories",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectCurrencyFactors",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectBMGroups",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdatePrices",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateCurrencies",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateColours",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateSeasons",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateSizes",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateLocations",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateCountries",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateShipmentMethods",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdatePaymentTerms",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateSlugCodes",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateItemDutyRates",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateBrandVendors",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateCategories",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateCurrencyFactors",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateBMGroups",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdateItems",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertAndUpdatePurchaseOrders",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertConsignment",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.UpdateConsignment",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertCustomsEntryForConsignment",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertConsignmentReturn",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.UpdateReturnToVendorStatus",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.UpdateReturnToVendorStock",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SetReturnToVendorAsCompleted",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertSalesOrder",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSalesOrders",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.UpdateSalesOrderRiskStatus",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.UpdateSalesOrderFraudStatus",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.UpdateSalesOrder",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertSalesOrderComments",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.CancelSalesOrder",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.UpdateSalesOrderStatus",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.InsertPaymentStatusUpdatedEvent",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SetSalesOrderToShipped",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSalesOrdersByCustomerEmail",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSalesOrderById",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSalesOrderLines",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSalesOrderHistory",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSalesOrderReturns",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSalesOrderReturnLines",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSalesOrderReturnHistory",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectSalesOrderComments",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectECourierFailures",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectCustomerCredits",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectCustomerOrdersByCustomerNumber",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectCustomerOrderByOrderReferenceAndCustomerNumber",
"Matches.SoftwareSystems.NAV.Containers.Database.Interfaces.SelectInventoryOrderByItemNumberAndSKUCode",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportPurchaseOrdersJob",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportConsignmentsJob",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportConsignmentStatusUpdatesJob",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportConsignmentReceipts",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportReturnsToVendorJob",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportReturnToVendorStatusUpdatesJob",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportReturnToVendorShippedEventsJob",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportSalesOrderStatusUpdatesJob",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportPaymentStatusUpdatesJob",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunImportShippedSalesOrdersJob",
"Matches.SoftwareSystems.NAV.Containers.ScheduledJobs.Interfaces.RunHandleCreateItemEventsJob",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendPurchaseOrderCreatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceivePurchaseOrderCreatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendConsignmentCreatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceiveConsignmentCreatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceiveConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendConsignmentReceiptedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceiveConsignmentReceiptedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendReturnToVendorCreatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceiveReturnToVendorCreatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendReturnToVendorStatusUpdatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceiveReturnToVendorStatusUpdatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendReturnToVendorShippedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceiveReturnToVendorShippedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendSalesOrderStatusUpdatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceiveSalesOrderStatusUpdatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendPaymentStatusUpdatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceivePaymentStatusUpdatedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendSalesOrderShippedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceiveSalesOrderShippedEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.SendCreateItemEvent",
"Matches.SoftwareSystems.NAV.Containers.SQS.Interfaces.ReceiveCreateItemEvent",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupPrices",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupCurrencies",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupColours",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupSeasons",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupSizes",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupLocations",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupCountries",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupShipmentMethods",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupPaymentTerms",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupSlugCodes",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupItemDutyRates",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupProductTaxData",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupBrandVendors",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupCategories",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupCurrencyFactors",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.SetupBMGroups",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.CreateCustomsEntryForConsignment",
"Matches.SoftwareSystems.NAV.Containers.UI.Interfaces.AllocateStockToVendorReturn",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.GetOrdersByCustomerId",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.PostOrderComments",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.BookCollection",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.RebookDelivery",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.GetOrderById",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.RequestComplianceDocuments",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.RequestLabels",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.GetFailedDeliveries",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.GetReturnReplacementOrderById",
"Matches.SoftwareSystems.OrderApp.Containers.API.Interfaces.GetReturnRequestById",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.ViewCustomerOrders",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.AddOrderComments",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.BookCollection",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.RebookDelivery",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.ViewOrderDetails",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.RequestComplianceDocuments",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.RequestLabels",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.ViewFailedDeliveries",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.ViewReturnReplacementOrder",
"Matches.SoftwareSystems.OrderApp.Containers.UI.Interfaces.ViewReturnRequest",
"Matches.SoftwareSystems.ParcelLab.Containers.API.Interfaces.UpdateSalesOrder",
"Matches.SoftwareSystems.ParcelLab.Containers.API.Interfaces.CancelSalesOrder",
"Matches.SoftwareSystems.ParcelLab.Containers.API.Interfaces.CreateSalesOrder",
"Matches.SoftwareSystems.ParcelLab.Containers.API.Interfaces.SendSalesOrderShippedEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQS.Interfaces.SendSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQS.Interfaces.SendSalesOrderCancelledEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderCancelledEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQS.Interfaces.SendSalesOrderCreatedEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderCreatedEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQS.Interfaces.SendSalesOrderShippedEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderShippedEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderCancelledEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderCreatedEvent",
"Matches.SoftwareSystems.ParcelLabAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderShippedEvent",
"Matches.SoftwareSystems.PayPalAdapter.Containers.API.Interfaces.SendPaymentStatusUpdate",
"Matches.SoftwareSystems.PricingService.Containers.API.Interfaces.GetPrices",
"Matches.SoftwareSystems.PricingService.Containers.Database.Interfaces.InsertAndUpdatePrices",
"Matches.SoftwareSystems.PricingService.Containers.Database.Interfaces.SelectPrices",
"Matches.SoftwareSystems.PricingService.Containers.Database.Interfaces.SelectLowLevelPriceData",
"Matches.SoftwareSystems.PricingService.Containers.PriceImporter.Interfaces.ImportPrices",
"Matches.SoftwareSystems.PricingService.Containers.PriceImporterScheduler.Interfaces.Start",
"Matches.SoftwareSystems.PricingService.Containers.PriceMonitor.Interfaces.Start",
"Matches.SoftwareSystems.PricingService.Containers.PriceViewer.Interfaces.ViewPrices",
"Matches.SoftwareSystems.ProductApp.Containers.API.Interfaces.SearchProducts",
"Matches.SoftwareSystems.ProductApp.Containers.API.Interfaces.GetProductByIdOrBarcode",
"Matches.SoftwareSystems.ProductApp.Containers.API.Interfaces.GetProductFacets",
"Matches.SoftwareSystems.ProductApp.Containers.API.Interfaces.GetProductStock",
"Matches.SoftwareSystems.ProductApp.Containers.API.Interfaces.GetProductParentById",
"Matches.SoftwareSystems.ProductLibrary.Containers.SQS.Interfaces.SendCreateMissingItemEvent",
"Matches.SoftwareSystems.ProductLibrary.Containers.SQS.Interfaces.ReceiveCreateMissingItemEvent",
"Matches.SoftwareSystems.ProductLibrary.Containers.SQSHandlers.Interfaces.HandleCreateMissingItemEvent",
"Matches.SoftwareSystems.RefundApp.Containers.API.Interfaces.CreateRefundOrder",
"Matches.SoftwareSystems.RefundApp.Containers.Database.Interfaces.CreateRefund",
"Matches.SoftwareSystems.RefundApp.Containers.Database.Interfaces.CreateRefundLog",
"Matches.SoftwareSystems.RefundApp.Containers.Database.Interfaces.UpdateRefund",
"Matches.SoftwareSystems.Riskified.Containers.API.Interfaces.CreateOrder",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.SendPaymentFailedEvent",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.PostGDPRIDRRequestAcknowledgements",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.PullCompletedIDRRequests",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.GDPRAcknowledgeIDRCompletion",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.PullInactiveDataRequests",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.PullRightToBeForgottenRequests",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.PostGDPRRequestAcknowledgements",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.PullCompletedRightToBeForgottenRequests",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.GDPRAcknowledgeCompletion",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.SendGDPRRequest",
"Matches.SoftwareSystems.SalesForce.Containers.API.Interfaces.UpdateGDPRRequestStatus",
"Matches.SoftwareSystems.SalesForceAdapter.Containers.SQS.Interfaces.SendPaymentFailedEvent",
"Matches.SoftwareSystems.SalesForceAdapter.Containers.SQS.Interfaces.ReceivePaymentFailedEvent",
"Matches.SoftwareSystems.SalesForceAdapter.Containers.SQSHandlers.Interfaces.HandlePaymentFailedEvent",
"Matches.SoftwareSystems.Search.Containers.Fredhopper.Interfaces.IndexProducts",
"Matches.SoftwareSystems.Search.Containers.Indexer.Interfaces.Start",
"Matches.SoftwareSystems.Search.Containers.SQS.Interfaces.SendProductPriceChangedEvent",
"Matches.SoftwareSystems.Search.Containers.SQS.Interfaces.ReceiveProductPriceChangedEvent",
"Matches.SoftwareSystems.SKUMappingService.Containers.API.Interfaces.GetMFSKUfromBrandSKU",
"Matches.SoftwareSystems.SKUMappingService.Containers.Database.Interfaces.SelectMFSKUForBrandSKU",
"Matches.SoftwareSystems.SKUMappingService.Containers.Database.Interfaces.InsertMFSKUForBrandSKU",
"Matches.SoftwareSystems.SKUMappingService.Containers.SQS.Interfaces.SendItemReleasedEvent",
"Matches.SoftwareSystems.SKUMappingService.Containers.SQS.Interfaces.ReceiveItemReleasedEvent",
"Matches.SoftwareSystems.SKUMappingService.Containers.SQSHandlers.Interfaces.HandleItemReleasedEvent",
"Matches.SoftwareSystems.StripeAdapter.Containers.API.Interfaces.SendPaymentStatusUpdate",
"Matches.SoftwareSystems.SupplierPortal.Containers.API.Interfaces.CreateConsignment",
"Matches.SoftwareSystems.WMS.Containers.API.Interfaces.SendConsignmentCreatedEvent",
"Matches.SoftwareSystems.WMS.Containers.API.Interfaces.CreateCustomsEntry",
"Matches.SoftwareSystems.WMS.Containers.API.Interfaces.SendReturnToVendorReleasedEvent",
"Matches.SoftwareSystems.WMS.Containers.API.Interfaces.UpdateSalesOrder",
"Matches.SoftwareSystems.WMS.Containers.API.Interfaces.CancelSalesOrder",
"Matches.SoftwareSystems.WMS.Containers.API.Interfaces.CreateSalesOrder",
"Matches.SoftwareSystems.WMS.Containers.API.Interfaces.UpdateOrder",
"Matches.SoftwareSystems.WMS.Containers.App.Interfaces.ProcessOrder",
"Matches.SoftwareSystems.WMS.Containers.App.Interfaces.ShipOrder",
"Matches.SoftwareSystems.WMS.Containers.SFTP.Interfaces.SendItemReleasedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.API.Interfaces.SendConsignmentStatusUpdatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.API.Interfaces.SendConsignmentReceiptedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.API.Interfaces.UpdateReturnToVendorStatus",
"Matches.SoftwareSystems.WMSAdapter.Containers.API.Interfaces.ShipReturnToVendor",
"Matches.SoftwareSystems.WMSAdapter.Containers.API.Interfaces.UpdateSalesOrderStatus",
"Matches.SoftwareSystems.WMSAdapter.Containers.API.Interfaces.SetSalesOrderToShipped",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.SendConsignmentCreatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.ReceiveConsignmentCreatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.SendItemReleasedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.ReceiveItemReleasedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.SendCustomsEntryCreatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.ReceiveCustomsEntryCreatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.SendReturnToVendorReleasedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.ReceiveReturnToVendorReleasedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.SendSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.SendSalesOrderCancelledEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderCancelledEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.SendSalesOrderCreatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderCreatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.SendPaymentFailedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQS.Interfaces.ReceivePaymentFailedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQSHandlers.Interfaces.HandleConsignmentCreatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQSHandlers.Interfaces.HandleItemReleasedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQSHandlers.Interfaces.HandleCustomsEntryCreatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQSHandlers.Interfaces.HandleReturnToVendorReleasedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderCancelledEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderCreatedEvent",
"Matches.SoftwareSystems.WMSAdapter.Containers.SQSHandlers.Interfaces.HandlePaymentFailedEvent",
"Matches.SoftwareSystems.ZigZag.Containers.API.Interfaces.CreateItem",
"Matches.SoftwareSystems.ZigZag.Containers.API.Interfaces.SendSalesOrderShippedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.Database.Interfaces.InsertItem",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.Database.Interfaces.UpdateSalesOrder",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.Database.Interfaces.CancelSalesOrder",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.Database.Interfaces.CreateSalesOrder",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.Database.Interfaces.UpdateSalesOrderStatus",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.Database.Interfaces.SetSalesOrderToShipped",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.SendItemReleasedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.ReceiveItemReleasedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.SendSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.SendSalesOrderCancelledEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderCancelledEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.SendSalesOrderCreatedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderCreatedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.SendSalesOrderStatusUpdatedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderStatusUpdatedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.SendSalesOrderShippedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQS.Interfaces.ReceiveSalesOrderShippedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQSHandlers.Interfaces.HandleItemReleasedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderUpdatedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderCancelledEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderCreatedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderStatusUpdatedEvent",
"Matches.SoftwareSystems.ZigZagAdapter.Containers.SQSHandlers.Interfaces.HandleSalesOrderShippedEvent"
],
"type": "string"
},
"SoftwareSystem": {
"properties": {
"Boundary": {
"enum": [
"Internal",
"External"
],
"type": "string"
},
"Containers": {
"additionalProperties": {
"$ref": "#/definitions/Container"
},
"type": "object"
},
"Interfaces": {
"additionalProperties": {
"$ref": "#/definitions/Interface"
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
nx-go/nx-go | 5a1656d179c469f26360dae179261d7ba1b53436 | 2022-02-28T02:09:22 | packages/nx-go/src/generators/library/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$id": "Library",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
nx-go/nx-go | a094a45d8d5230adec23f80128f5eb72543a0f7a | 2021-12-27T09:24:00 | packages/nx-go/src/generators/application/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$id": "Application",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"skipGoMod": {
"default": false,
"description": "Skip creation of go.mod.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
nx-go/nx-go | a094a45d8d5230adec23f80128f5eb72543a0f7a | 2021-12-27T09:24:00 | packages/nx-go/src/executors/lint/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "",
"properties": {},
"required": [],
"title": "Lint executor",
"type": "object"
} | MIT | en |
nx-go/nx-go | f47c266074d0b8c073158b9a337a6b43fbb88560 | 2022-10-17T07:45:28 | packages/nx-go/src/generators/application/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$id": "Application",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"skipGoMod": {
"default": false,
"description": "Skip creation of go.mod.",
"type": "boolean"
},
"skipVersionCheck": {
"default": false,
"description": "Skip the version verification if used with --useGoWork",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
},
"useGoWork": {
"default": false,
"description": "Use a go.work file at root instead of go.mod",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
nx-go/nx-go | 8d4f318bc95434e6636892102c4b4371deb41132 | 2022-07-02T14:40:40 | packages/nx-go/src/executors/lint/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Lints the code for the Go project.",
"properties": {
"args": {
"description": "Additional arguments to the linter",
"type": "string"
},
"linter": {
"description": "The command to execute when running the lint executor.",
"type": "string"
}
},
"required": [],
"title": "Lint executor",
"type": "object"
} | MIT | en |
nx-go/nx-go | a5bee36f78fd4c820fdece8d8e59e82e5ebf3472 | 2024-02-22T18:09:47 | packages/nx-go/src/executors/serve/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$schema": "https://json-schema.org/schema",
"description": "Go serve options",
"properties": {
"args": {
"alias": "arguments",
"description": "Extra args when starting the app",
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"default": "go",
"description": "Name of the go binary to use, default is go",
"type": "string"
},
"cwd": {
"description": "Working directory from which to run the application",
"type": "string",
"x-completion-type": "directory"
},
"main": {
"description": "Path to the file containing the main() function",
"type": "string",
"x-completion-glob": "main.go",
"x-completion-type": "file",
"x-priority": "important"
}
},
"required": [
"main"
],
"title": "Serve executor",
"type": "object",
"version": 2
} | MIT | en |
nx-go/nx-go | a5bee36f78fd4c820fdece8d8e59e82e5ebf3472 | 2024-02-22T18:09:47 | packages/nx-go/src/generators/library/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$id": "@nx-go/nx-go:library",
"$schema": "https://json-schema.org/schema",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed.",
"type": "string",
"x-priority": "important"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Name of the project to generate.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
}
},
"required": [
"name"
],
"title": "Go library generator options",
"type": "object"
} | MIT | en |
nx-go/nx-go | a5bee36f78fd4c820fdece8d8e59e82e5ebf3472 | 2024-02-22T18:09:47 | packages/nx-go/src/generators/init/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$id": "@nx-go/nx-go:init",
"$schema": "https://json-schema.org/schema",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"title": "Go init generator options",
"type": "object"
} | MIT | en |
nx-go/nx-go | a5bee36f78fd4c820fdece8d8e59e82e5ebf3472 | 2024-02-22T18:09:47 | packages/nx-go/src/generators/application/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$id": "@nx-go/nx-go:application",
"$schema": "https://json-schema.org/schema",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed.",
"type": "string",
"x-priority": "important"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Name of the project to generate.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
}
},
"required": [
"name"
],
"title": "Go application generator options",
"type": "object"
} | MIT | en |
nx-go/nx-go | 722f1ede0f3804786c3326db53d55835f497bf7f | 2024-05-01T22:06:45 | packages/nx-go/src/executors/tidy/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$schema": "https://json-schema.org/schema",
"description": "Runs the `go mod tidy` command",
"properties": {
"args": {
"description": "Extra args when mod tidy the app or library",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [],
"title": "Tidy executor",
"type": "object",
"version": 2
} | MIT | en |
nx-go/nx-go | e9f0a674aa16c365862d8c801a859c6c8f8b40f1 | 2022-03-01T03:51:58 | packages/nx-go/src/executors/serve/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Run the Go application",
"properties": {
"arguments": {
"default": [],
"description": "Command line arguments for the application",
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"default": "go",
"description": "Name of the go binary (usually 'go')",
"type": "string"
},
"cwd": {
"default": "",
"description": "Working directory from which to run the application",
"type": "string"
},
"main": {
"default": "main.go",
"description": "Name of the file containing the main() function",
"type": "string"
}
},
"required": [],
"title": "Serve executor",
"type": "object"
} | MIT | en |
nx-go/nx-go | a5bee36f78fd4c820fdece8d8e59e82e5ebf3472 | 2024-02-22T18:09:47 | packages/nx-go/src/generators/preset/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$id": "@nx-go/nx-go:preset",
"$schema": "https://json-schema.org/schema",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"title": "Go preset generator options",
"type": "object"
} | MIT | en |
nx-go/nx-go | a5bee36f78fd4c820fdece8d8e59e82e5ebf3472 | 2024-02-22T18:09:47 | packages/nx-go/src/executors/lint/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$schema": "https://json-schema.org/schema",
"description": "Go lint options",
"properties": {
"args": {
"description": "Extra args when linting the app",
"items": {
"type": "string"
},
"type": "array"
},
"linter": {
"description": "The command to execute when running the lint executor.",
"type": "string"
}
},
"required": [],
"title": "Lint executor",
"type": "object",
"version": 2
} | MIT | en |
nx-go/nx-go | 81544df0296f6b94e17cf9e6cd1dfe25a386d562 | 2024-03-05T19:09:00 | packages/nx-go/src/executors/serve/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$schema": "https://json-schema.org/schema",
"description": "Runs a Go program using the `go run` command",
"properties": {
"args": {
"alias": "arguments",
"description": "Extra args when starting the app",
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"default": "go",
"description": "Name of the go binary to use, default is go",
"type": "string"
},
"cwd": {
"description": "Working directory from which to run the application",
"type": "string",
"x-completion-type": "directory"
},
"main": {
"description": "Path to the file containing the main() function",
"type": "string",
"x-completion-glob": "main.go",
"x-completion-type": "file",
"x-priority": "important"
}
},
"required": [
"main"
],
"title": "Serve executor",
"type": "object",
"version": 2
} | MIT | en |
nx-go/nx-go | a094a45d8d5230adec23f80128f5eb72543a0f7a | 2021-12-27T09:24:00 | packages/nx-go/src/executors/serve/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "",
"properties": {},
"required": [],
"title": "Serve executor",
"type": "object"
} | MIT | en |
nx-go/nx-go | a094a45d8d5230adec23f80128f5eb72543a0f7a | 2021-12-27T09:24:00 | packages/nx-go/src/generators/library/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$id": "Library",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"directory": {
"alias": "d",
"description": "A directory where the project is placed",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"tags": {
"alias": "t",
"description": "Add tags to the project (used for linting)",
"type": "string"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
nx-go/nx-go | 81544df0296f6b94e17cf9e6cd1dfe25a386d562 | 2024-03-05T19:09:00 | packages/nx-go/src/executors/lint/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$schema": "https://json-schema.org/schema",
"description": "Lints Go code using the `go fmt` command",
"properties": {
"args": {
"description": "Extra args when linting the app",
"items": {
"type": "string"
},
"type": "array"
},
"linter": {
"description": "The command to execute when running the lint executor.",
"type": "string"
}
},
"required": [],
"title": "Lint executor",
"type": "object",
"version": 2
} | MIT | en |
nx-go/nx-go | a5bee36f78fd4c820fdece8d8e59e82e5ebf3472 | 2024-02-22T18:09:47 | packages/nx-go/src/generators/convert-to-one-mod/schema.json | 395 | 2024-05-28T05:53:49.871752Z | {
"$id": "@nx-go/convert-to-one-mod",
"$schema": "https://json-schema.org/schema",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"title": "Go convert-to-one-mod generator options",
"type": "object"
} | MIT | en |
impierce/ssi-agent | 1b944ee4afb4e76b8ca53882a4e8d2a0472bc804 | 2023-11-22T14:11:24 | agent_issuance/res/json_schema/openbadges_v3.json | 8 | 2024-05-27T09:57:57.995529Z | {
"$defs": {
"Achievement": {
"additionalProperties": true,
"description": "A collection of information about the accomplishment recognized by the Assertion. Many assertions may be created corresponding to one Achievement.",
"properties": {
"@language": {
"$comment": "Origin: LanguageCode (DerivedType); A language code [[BCP47]].",
"description": "The language of the achievement.",
"pattern": "^[a-z]{2,4}(-[A-Z][a-z]{3})?(-([A-Z]{2}|[0-9]{3}))?$",
"type": "string"
},
"achievementType": {
"$comment": "Origin: AchievementType (EnumExt); The type of achievement, for example 'Award' or 'Certification'. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.",
"anyOf": [
{
"enum": [
"Achievement",
"ApprenticeshipCertificate",
"Assessment",
"Assignment",
"AssociateDegree",
"Award",
"Badge",
"BachelorDegree",
"Certificate",
"CertificateOfCompletion",
"Certification",
"CommunityService",
"Competency",
"Course",
"CoCurricular",
"Degree",
"Diploma",
"DoctoralDegree",
"Fieldwork",
"GeneralEducationDevelopment",
"JourneymanCertificate",
"LearningProgram",
"License",
"Membership",
"ProfessionalDoctorate",
"QualityAssuranceCredential",
"MasterCertificate",
"MasterDegree",
"MicroCredential",
"ResearchDoctorate",
"SecondarySchoolDiploma"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The type of achievement. This is an extensible vocabulary."
},
"alignment": {
"items": {
"$ref": "#/$defs/Alignment"
},
"type": "array"
},
"creator": {
"$ref": "#/$defs/Profile"
},
"creditsAvailable": {
"$comment": "Origin: Float (PrimitiveType)",
"description": "Credit hours associated with this entity, or credit hours possible. For example 3.0.",
"type": "number"
},
"criteria": {
"$ref": "#/$defs/Criteria"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A short description of the achievement.",
"type": "string"
},
"endorsement": {
"items": {
"$ref": "#/$defs/EndorsementCredential"
},
"type": "array"
},
"endorsementJwt": {
"items": {
"$comment": "Origin: CompactJws (DerivedType); A `String` in Compact JWS format [[RFC7515]].",
"description": "Allows endorsers to make specific claims about the Achievement. These endorsements are signed with the VC-JWT proof format.",
"pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$",
"type": "string"
},
"type": "array"
},
"fieldOfStudy": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.",
"type": "string"
},
"humanCode": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The code, generally human readable, associated with an achievement.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "Unique URI for the Achievement.",
"type": "string"
},
"image": {
"$ref": "#/$defs/Image"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the achievement.",
"type": "string"
},
"otherIdentifier": {
"items": {
"$ref": "#/$defs/IdentifierEntry"
},
"type": "array"
},
"related": {
"items": {
"$ref": "#/$defs/Related"
},
"type": "array"
},
"resultDescription": {
"items": {
"$ref": "#/$defs/ResultDescription"
},
"type": "array"
},
"specialization": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include 'Entrepreneurship', 'Technical Communication', and 'Finance'.",
"type": "string"
},
"tag": {
"items": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "One or more short, human-friendly, searchable, keywords that describe the type of achievement.",
"type": "string"
},
"type": "array"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "No description supplied.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "No description supplied.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"version": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The version property allows issuers to set a version string for an Achievement. This is particularly useful when replacing a previous version with an update.",
"type": "string"
}
},
"required": [
"id",
"type",
"criteria",
"description",
"name"
],
"type": "object"
},
"AchievementSubject": {
"additionalProperties": true,
"description": "A collection of information about the recipient of an achievement. Maps to Credential Subject in [[VC-DATA-MODEL]].",
"properties": {
"achievement": {
"$ref": "#/$defs/Achievement"
},
"activityEndDate": {
"$comment": "Origin: DateTime (PrimitiveType); An [[ISO8601]] time using the syntax YYYY-MM-DDThh:mm:ss.",
"description": "The datetime the activity ended.",
"format": "date-time",
"type": "string"
},
"activityStartDate": {
"$comment": "Origin: DateTime (PrimitiveType); An [[ISO8601]] time using the syntax YYYY-MM-DDThh:mm:ss.",
"description": "The datetime the activity started.",
"format": "date-time",
"type": "string"
},
"creditsEarned": {
"$comment": "Origin: Float (PrimitiveType)",
"description": "The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement `creditsAvailable` field.",
"type": "number"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "An identifier for the Credential Subject. Either `id` or at least one `identifier` MUST be supplied.",
"type": "string"
},
"identifier": {
"items": {
"$ref": "#/$defs/IdentityObject"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image"
},
"licenseNumber": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The license number that was issued with this credential.",
"type": "string"
},
"narrative": {
"$comment": "Origin: Markdown (DerivedType); A `String` that may contain Markdown.",
"description": "A narrative that connects multiple pieces of evidence. Likely only present at this location if evidence is a multi-value array.",
"type": "string"
},
"result": {
"items": {
"$ref": "#/$defs/Result"
},
"type": "array"
},
"role": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Role, position, or title of the learner when demonstrating or performing the achievement or evidence of learning being asserted. Examples include 'Student President', 'Intern', 'Captain', etc.",
"type": "string"
},
"source": {
"$ref": "#/$defs/Profile"
},
"term": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The academic term in which this assertion was achieved.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'AchievementSubject'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'AchievementSubject'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"type",
"achievement"
],
"type": "object"
},
"Address": {
"additionalProperties": true,
"description": "An address for the described entity.",
"properties": {
"addressCountry": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A country.",
"type": "string"
},
"addressCountryCode": {
"$comment": "Origin: CountryCode (DerivedType); A two-digit ISO 3166-1 alpha-2 country code [[ISO3166-1]].",
"description": "A country code. The value must be a ISO 3166-1 alpha-2 country code [[ISO3166-1]].",
"type": "string"
},
"addressLocality": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A locality within the region.",
"type": "string"
},
"addressRegion": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A region within the country.",
"type": "string"
},
"geo": {
"$ref": "#/$defs/GeoCoordinates"
},
"postOfficeBoxNumber": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A post office box number for PO box addresses.",
"type": "string"
},
"postalCode": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A postal code.",
"type": "string"
},
"streetAddress": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A street address within the locality.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Address'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Address'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Alignment": {
"additionalProperties": true,
"description": "Describes an alignment between an achievement and a node in an educational framework.",
"properties": {
"targetCode": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "If applicable, a locally unique string identifier that identifies the alignment target within its framework and/or targetUrl.",
"type": "string"
},
"targetDescription": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Short description of the alignment target.",
"type": "string"
},
"targetFramework": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Name of the framework the alignment target.",
"type": "string"
},
"targetName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Name of the alignment.",
"type": "string"
},
"targetType": {
"$comment": "Origin: AlignmentTargetType (EnumExt); The type of the alignment target node in the target framework.",
"anyOf": [
{
"enum": [
"ceasn:Competency",
"ceterms:Credential",
"CFItem",
"CFRubric",
"CFRubricCriterion",
"CFRubricCriterionLevel",
"CTDL"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The type of the alignment target node."
},
"targetUrl": {
"$comment": "Origin: URL (DerivedType); A `URI` that represents a Uniform Resource Locator (URL).",
"description": "URL linking to the official description of the alignment target, for example an individual standard within an educational framework.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Alignment'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Alignment'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"type",
"targetName",
"targetUrl"
],
"type": "object"
},
"Context": {
"anyOf": [
{
"$comment": "Origin: Map (PrimitiveType); A map representing an object with unknown, arbitrary properties",
"description": "A map representing an object with unknown, arbitrary properties",
"type": "object"
},
{
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"type": "string"
}
],
"description": "JSON-LD Context. Either a URI with the context definition or a Map with a local context definition MUST be supplied."
},
"CredentialSchema": {
"additionalProperties": true,
"description": "Identify the type and location of a data schema.",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The value MUST be a URI identifying the schema file. One instance of `CredentialSchema` MUST have an `id` that is the URL of the JSON Schema for this credential defined by this specification.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value MUST identify the type of data schema validation. One instance of `CredentialSchema` MUST have a `type` of 'JsonSchemaValidator2019'.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"CredentialStatus": {
"additionalProperties": true,
"description": "The information in CredentialStatus is used to discover information about the current status of a verifiable credential, such as whether it is suspended or revoked.",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The value MUST be the URL of the issuer's credential status method.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The name of the credential status method.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Criteria": {
"additionalProperties": true,
"description": "Descriptive metadata about the achievements necessary to be recognized with an assertion of a particular achievement. This data is added to the Achievement class so that it may be rendered when the achievement assertion is displayed, instead of simply a link to human-readable criteria external to the achievement. Embedding criteria allows either enhancement of an external criteria page or increased portability and ease of use by allowing issuers to skip hosting the formerly-required external criteria page altogether. Criteria is used to allow would-be recipients to learn what is required of them to be recognized with an assertion of a particular achievement. It is also used after the assertion is awarded to a recipient to let those inspecting earned achievements know the general requirements that the recipients met in order to earn it.",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The URI of a webpage that describes in a human-readable format the criteria for the achievement.",
"type": "string"
},
"narrative": {
"$comment": "Origin: Markdown (DerivedType); A `String` that may contain Markdown.",
"description": "A narrative of what is needed to earn the achievement. Markdown is allowed.",
"type": "string"
}
},
"required": [],
"type": "object"
},
"EndorsementCredential": {
"additionalProperties": true,
"description": "A verifiable credential that asserts a claim about an entity. As described in [[[#data-integrity]]], at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.",
"properties": {
"@context": {
"items": {
"$ref": "#/$defs/Context"
},
"minItems": 1,
"type": "array"
},
"awardedDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "Timestamp of when the credential was awarded. `issuanceDate` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `issuanceDate`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.",
"format": "date-time",
"type": "string"
},
"credentialSchema": {
"oneOf": [
{
"$ref": "#/$defs/CredentialSchema"
},
{
"items": {
"$ref": "#/$defs/CredentialSchema"
},
"type": "array"
}
]
},
"credentialStatus": {
"$ref": "#/$defs/CredentialStatus"
},
"credentialSubject": {
"$ref": "#/$defs/EndorsementSubject"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The short description of the credential for display purposes in wallets.",
"type": "string"
},
"expirationDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "If the credential has some notion of expiry, this indicates a timestamp when a credential should no longer be considered valid. After this time, the credential should be considered expired.",
"format": "date-time",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "Unambiguous reference to the credential.",
"type": "string"
},
"issuanceDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "Timestamp of when the credential was issued.",
"format": "date-time",
"type": "string"
},
"issuer": {
"$ref": "#/$defs/Profile"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.",
"type": "string"
},
"proof": {
"oneOf": [
{
"$ref": "#/$defs/Proof"
},
{
"items": {
"$ref": "#/$defs/Proof"
},
"type": "array"
}
]
},
"refreshService": {
"$ref": "#/$defs/RefreshService"
},
"termsOfUse": {
"oneOf": [
{
"$ref": "#/$defs/TermsOfUse"
},
{
"items": {
"$ref": "#/$defs/TermsOfUse"
},
"type": "array"
}
]
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'EndorsementCredential'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'EndorsementCredential'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"@context",
"type",
"id",
"name",
"credentialSubject",
"issuer",
"issuanceDate"
],
"type": "object"
},
"EndorsementSubject": {
"additionalProperties": true,
"description": "A collection of information about the subject of the endorsement.",
"properties": {
"endorsementComment": {
"$comment": "Origin: Markdown (DerivedType); A `String` that may contain Markdown.",
"description": "Allows endorsers to make a simple claim in writing about the entity.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The identifier of the individual, entity, organization, assertion, or achievement that is endorsed.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'EndorsementSubject'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'EndorsementSubject'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Evidence": {
"additionalProperties": true,
"description": "Descriptive metadata about evidence related to the achievement assertion. Each instance of the evidence class present in an assertion corresponds to one entity, though a single entry can describe a set of items collectively. There may be multiple evidence entries referenced from an assertion. The narrative property is also in scope of the assertion class to provide an overall description of the achievement related to the assertion in rich text. It is used here to provide a narrative of achievement of the specific entity described. If both the description and narrative properties are present, displayers can assume the narrative value goes into more detail and is not simply a recapitulation of description.",
"properties": {
"audience": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A description of the intended audience for a piece of evidence.",
"type": "string"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A longer description of the evidence.",
"type": "string"
},
"genre": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A string that describes the type of evidence. For example, Poetry, Prose, Film.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The URL of a webpage presenting evidence of achievement or the evidence encoded as a Data URI. The schema of the webpage is undefined.",
"type": "string"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A descriptive title of the evidence.",
"type": "string"
},
"narrative": {
"$comment": "Origin: Markdown (DerivedType); A `String` that may contain Markdown.",
"description": "A narrative that describes the evidence and process of achievement that led to an assertion.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Evidence'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Evidence'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"GeoCoordinates": {
"additionalProperties": true,
"description": "The geographic coordinates of a location.",
"properties": {
"latitude": {
"$comment": "Origin: Float (PrimitiveType)",
"description": "The latitude of the location [[WGS84]].",
"type": "number"
},
"longitude": {
"$comment": "Origin: Float (PrimitiveType)",
"description": "The longitude of the location [[WGS84]].",
"type": "number"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'GeoCoordinates'.",
"type": "string"
}
},
"required": [
"type",
"latitude",
"longitude"
],
"type": "object"
},
"IdentifierEntry": {
"additionalProperties": false,
"description": "No description supplied.",
"properties": {
"identifier": {
"$comment": "Origin: Identifier (DerivedType); A `NormalizedString` that functions as an identifier.",
"description": "An identifier.",
"type": "string"
},
"identifierType": {
"$comment": "Origin: IdentifierTypeEnum (EnumExt)",
"anyOf": [
{
"enum": [
"name",
"sourcedId",
"systemId",
"productId",
"userName",
"accountId",
"emailAddress",
"nationalIdentityNumber",
"isbn",
"issn",
"lisSourcedId",
"oneRosterSourcedId",
"sisSourcedId",
"ltiContextId",
"ltiDeploymentId",
"ltiToolId",
"ltiPlatformId",
"ltiUserId",
"identifier"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The identifier type."
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'IdentifierEntry'.",
"type": "string"
}
},
"required": [
"type",
"identifier",
"identifierType"
],
"type": "object"
},
"IdentityObject": {
"additionalProperties": false,
"description": "A collection of information about the recipient of an achievement.",
"properties": {
"hashed": {
"$comment": "Origin: Boolean (PrimitiveType); A boolean, expressed as `true` or `false`",
"description": "Whether or not the `identityHash` value is hashed.",
"type": "boolean"
},
"identityHash": {
"$comment": "Origin: IdentityHash (DerivedType); A `String` consisting of an algorithm identifier, a `$` separator, and a hash across an identifier and an optionally appended salt string. The only supported algorithms are MD5 [[RFC1321]] and SHA-256 [[FIPS-180-4]], identified by the strings 'md5' and 'sha256' respectively. Identifiers and salts MUST be encoded in UTF-8 prior to hashing, and the resulting hash MUST be expressed in hexadecimal using uppercase (A-F, 0-9) or lowercase character (a-f, 0-9) sets. For example: 'sha256$b5809d8a92f8858436d7e6b87c12ebc0ae1eac4baecc2c0b913aee2c922ef399' represents the result of calculating a SHA-256 hash on the string '[email protected]'. in which the email identifier '[email protected]' is salted with 'Kosher'",
"description": "Either the IdentityHash of the identity or the plaintext value. If it's possible that the plaintext transmission and storage of the identity value would leak personally identifiable information where there is an expectation of privacy, it is strongly recommended that an IdentityHash be used.",
"type": "string"
},
"identityType": {
"$comment": "Origin: IdentifierTypeEnum (EnumExt)",
"anyOf": [
{
"enum": [
"name",
"sourcedId",
"systemId",
"productId",
"userName",
"accountId",
"emailAddress",
"nationalIdentityNumber",
"isbn",
"issn",
"lisSourcedId",
"oneRosterSourcedId",
"sisSourcedId",
"ltiContextId",
"ltiDeploymentId",
"ltiToolId",
"ltiPlatformId",
"ltiUserId",
"identifier"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The identity type."
},
"salt": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "If the `identityHash` is hashed, this should contain the string used to salt the hash. If this value is not provided, it should be assumed that the hash was not salted.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "MUST be the IRI 'IdentityObject'.",
"type": "string"
}
},
"required": [
"type",
"hashed",
"identityHash",
"identityType"
],
"type": "object"
},
"Image": {
"additionalProperties": false,
"description": "Metadata about images that represent assertions, achieve or profiles. These properties can typically be represented as just the id string of the image, but using a fleshed-out document allows for including captions and other applicable metadata.",
"properties": {
"caption": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The caption for the image.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The URI or Data URI of the image.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "MUST be the IRI 'Image'.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Profile": {
"additionalProperties": true,
"description": "A Profile is a collection of information that describes the entity or organization using Open Badges. Issuers must be represented as Profiles, and endorsers, or other entities may also be represented using this vocabulary. Each Profile that represents an Issuer may be referenced in many BadgeClasses that it has defined. Anyone can create and host an Issuer file to start issuing Open Badges. Issuers may also serve as recipients of Open Badges, often identified within an Assertion by specific properties, like their url or contact email address.",
"properties": {
"additionalName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Additional name. Includes what is often referred to as 'middle name' in the western world.",
"type": "string"
},
"address": {
"$ref": "#/$defs/Address"
},
"dateOfBirth": {
"$comment": "Origin: Date (PrimitiveType); An [[ISO8601]] calendar date using the syntax YYYY-MM-DD.",
"description": "Birthdate of the person.",
"format": "date",
"type": "string"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A short description of the issuer entity or organization.",
"type": "string"
},
"email": {
"$comment": "Origin: EmailAddress (DerivedType); A `NormalizedString` representing an email address.",
"description": "An email address.",
"type": "string"
},
"endorsement": {
"items": {
"$ref": "#/$defs/EndorsementCredential"
},
"type": "array"
},
"endorsementJwt": {
"items": {
"$comment": "Origin: CompactJws (DerivedType); A `String` in Compact JWS format [[RFC7515]].",
"description": "Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with the VC-JWT proof format.",
"pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$",
"type": "string"
},
"type": "array"
},
"familyName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Family name. In the western world, often referred to as the 'last name' of a person.",
"type": "string"
},
"familyNamePrefix": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Family name prefix. As used in some locales, this is the leading part of a family name (e.g. 'de' in the name 'de Boer').",
"type": "string"
},
"givenName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Given name. In the western world, often referred to as the 'first name' of a person.",
"type": "string"
},
"honorificPrefix": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Honorific prefix(es) preceding a person's name (e.g. 'Dr', 'Mrs' or 'Mr').",
"type": "string"
},
"honorificSuffix": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Honorific suffix(es) following a person's name (e.g. 'M.D, PhD').",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "Unique URI for the Issuer/Profile file.",
"type": "string"
},
"image": {
"$ref": "#/$defs/Image"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the entity or organization.",
"type": "string"
},
"official": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "If the entity is an organization, `official` is the name of an authorized official of the organization.",
"type": "string"
},
"otherIdentifier": {
"items": {
"$ref": "#/$defs/IdentifierEntry"
},
"type": "array"
},
"parentOrg": {
"$ref": "#/$defs/Profile"
},
"patronymicName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Patronymic name.",
"type": "string"
},
"phone": {
"$comment": "Origin: PhoneNumber (DerivedType); A `NormalizedString` representing a phone number.",
"description": "A phone number.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Profile'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Profile'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"url": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The homepage or social media profile of the entity, whether individual or institutional. Should be a URL/URI Accessible via HTTP.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Proof": {
"additionalProperties": true,
"description": "A JSON-LD Linked Data proof.",
"properties": {
"challenge": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A value chosen by the verifier to mitigate authentication proof replay attacks.",
"type": "string"
},
"created": {
"$comment": "Origin: DateTime (PrimitiveType); An [[ISO8601]] time using the syntax YYYY-MM-DDThh:mm:ss.",
"description": "Date the proof was created.",
"format": "date-time",
"type": "string"
},
"cryptosuite": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The suite used to create the proof.",
"type": "string"
},
"domain": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The domain of the proof to restrict its use to a particular target.",
"type": "string"
},
"nonce": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A value chosen by the creator of proof to randomize proof values for privacy purposes.",
"type": "string"
},
"proofPurpose": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The purpose of the proof to be used with `verificationMethod`. MUST be 'assertionMethod'.",
"type": "string"
},
"proofValue": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Value of the proof.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "Signature suite used to produce proof.",
"type": "string"
},
"verificationMethod": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The URL of the public key that can verify the signature.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"RefreshService": {
"additionalProperties": true,
"description": "The information in RefreshService is used to refresh the verifiable credential.",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The value MUST be the URL of the issuer's refresh service.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The name of the refresh service method.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Related": {
"additionalProperties": true,
"description": "Identifies a related achievement.",
"properties": {
"@language": {
"$comment": "Origin: LanguageCode (DerivedType); A language code [[BCP47]].",
"description": "The language of the related achievement.",
"pattern": "^[a-z]{2,4}(-[A-Z][a-z]{3})?(-([A-Z]{2}|[0-9]{3}))?$",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The related achievement.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Related'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Related'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"version": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The version of the related achievement.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Result": {
"additionalProperties": true,
"description": "Describes a result that was achieved.",
"properties": {
"achievedLevel": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "If the result represents an achieved rubric criterion level (e.g. Mastered), the value is the `id` of the RubricCriterionLevel in linked ResultDescription.",
"type": "string"
},
"alignment": {
"items": {
"$ref": "#/$defs/Alignment"
},
"type": "array"
},
"resultDescription": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "An achievement can have many result descriptions describing possible results. The value of `resultDescription` is the `id` of the result description linked to this result. The linked result description must be in the achievement that is being asserted.",
"type": "string"
},
"status": {
"$comment": "Origin: ResultStatusType (Enumeration); Defined vocabulary to convey the status of an achievement.",
"description": "The status of the achievement. Required if `resultType` of the linked ResultDescription is Status.",
"enum": [
"Completed",
"Enrolled",
"Failed",
"InProgress",
"OnHold",
"Withdrew"
],
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Result'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Result'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"value": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A string representing the result of the performance, or demonstration, of the achievement. For example, 'A' if the recipient received an A grade in class.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ResultDescription": {
"additionalProperties": true,
"description": "Describes a possible achievement result.",
"properties": {
"alignment": {
"items": {
"$ref": "#/$defs/Alignment"
},
"type": "array"
},
"allowedValue": {
"items": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "An ordered list of allowed values. The values should be ordered from low to high as determined by the achievement creator.",
"type": "string"
},
"type": "array"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The unique URI for this result description. Required so a result can link to this result description.",
"type": "string"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the result.",
"type": "string"
},
"requiredLevel": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The `id` of the rubric criterion level required to pass as determined by the achievement creator.",
"type": "string"
},
"requiredValue": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A value from `allowedValue` or within the range of `valueMin` to `valueMax` required to pass as determined by the achievement creator.",
"type": "string"
},
"resultType": {
"$comment": "Origin: ResultType (EnumExt); The type of result. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.",
"anyOf": [
{
"enum": [
"GradePointAverage",
"LetterGrade",
"Percent",
"PerformanceLevel",
"PredictedScore",
"RawScore",
"Result",
"RubricCriterion",
"RubricCriterionLevel",
"RubricScore",
"ScaledScore",
"Status"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The type of result this description represents. This is an extensible enumerated vocabulary."
},
"rubricCriterionLevel": {
"items": {
"$ref": "#/$defs/RubricCriterionLevel"
},
"type": "array"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'ResultDescription'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'ResultDescription'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"valueMax": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The maximum possible `value` that may be asserted in a linked result.",
"type": "string"
},
"valueMin": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The minimum possible `value` that may be asserted in a linked result.",
"type": "string"
}
},
"required": [
"id",
"type",
"name",
"resultType"
],
"type": "object"
},
"RubricCriterionLevel": {
"additionalProperties": true,
"description": "Describes a rubric criterion level.",
"properties": {
"alignment": {
"items": {
"$ref": "#/$defs/Alignment"
},
"type": "array"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Description of the rubric criterion level.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The unique URI for this rubric criterion level. Required so a result can link to this rubric criterion level.",
"type": "string"
},
"level": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The rubric performance level in terms of success.",
"type": "string"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the rubric criterion level.",
"type": "string"
},
"points": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The points associated with this rubric criterion level.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'RubricCriterionLevel'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'RubricCriterionLevel'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"id",
"type",
"name"
],
"type": "object"
},
"TermsOfUse": {
"additionalProperties": true,
"description": "Terms of use can be utilized by an issuer or a holder to communicate the terms under which a verifiable credential or verifiable presentation was issued",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The value MUST be a URI identifying the term of use.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value MUST identify the type of the terms of use.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"$id": "https://purl.imsglobal.org/spec/ob/v3p0/schema/json/ob_v3p0_achievementcredential_schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": true,
"description": "AchievementCredentials are representations of an awarded achievement, used to share information about a achievement belonging to one earner. Maps to a Verifiable Credential as defined in the [[VC-DATA-MODEL]]. As described in [[[#data-integrity]]], at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.",
"properties": {
"@context": {
"items": {
"$ref": "#/$defs/Context"
},
"minItems": 1,
"type": "array"
},
"awardedDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "Timestamp of when the credential was awarded. `issuanceDate` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `issuanceDate`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.",
"format": "date-time",
"type": "string"
},
"credentialSchema": {
"oneOf": [
{
"$ref": "#/$defs/CredentialSchema"
},
{
"items": {
"$ref": "#/$defs/CredentialSchema"
},
"type": "array"
}
]
},
"credentialStatus": {
"$ref": "#/$defs/CredentialStatus"
},
"credentialSubject": {
"$ref": "#/$defs/AchievementSubject"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The short description of the credential for display purposes in wallets.",
"type": "string"
},
"endorsement": {
"items": {
"$ref": "#/$defs/EndorsementCredential"
},
"type": "array"
},
"endorsementJwt": {
"items": {
"$comment": "Origin: CompactJws (DerivedType); A `String` in Compact JWS format [[RFC7515]].",
"description": "Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with the VC-JWT proof format.",
"pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$",
"type": "string"
},
"type": "array"
},
"evidence": {
"items": {
"$ref": "#/$defs/Evidence"
},
"type": "array"
},
"expirationDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "If the credential has some notion of expiry, this indicates a timestamp when a credential should no longer be considered valid. After this time, the credential should be considered expired.",
"format": "date-time",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "Unambiguous reference to the credential.",
"type": "string"
},
"image": {
"$ref": "#/$defs/Image"
},
"issuanceDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "Timestamp of when the credential was issued.",
"format": "date-time",
"type": "string"
},
"issuer": {
"$ref": "#/$defs/Profile"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.",
"type": "string"
},
"proof": {
"oneOf": [
{
"$ref": "#/$defs/Proof"
},
{
"items": {
"$ref": "#/$defs/Proof"
},
"type": "array"
}
]
},
"refreshService": {
"$ref": "#/$defs/RefreshService"
},
"termsOfUse": {
"oneOf": [
{
"$ref": "#/$defs/TermsOfUse"
},
{
"items": {
"$ref": "#/$defs/TermsOfUse"
},
"type": "array"
}
]
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'AchievementCredential' or the URI 'OpenBadgeCredential'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'AchievementCredential' or the URI 'OpenBadgeCredential'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"@context",
"id",
"type",
"name",
"credentialSubject",
"issuer",
"issuanceDate"
],
"title": "JSON Schema for the AchievementCredential class.",
"type": "object"
} | Apache-2.0 | en |
aocjs/cli | 8ace55e16003b975fda44a1a8a5c330a9b532ff1 | 2021-10-07T11:17:40 | schema/schema.json | 7 | 2024-05-27T04:20:39.439894Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"compiler": {
"description": "Defines language used on generated templates",
"pattern": "^(js|ts)$",
"type": "string"
},
"session": {
"description": "Your personal session cookie from adventofcode.com. Required to fetch data.",
"type": "string"
},
"year": {
"description": "Year you are currently solving",
"minimum": 2015,
"type": "integer"
}
},
"title": "@aocjs/cli config definition",
"type": "object"
} | MIT | en |
piiano/cellotape | e8e010bd5ec44c7e1fbd33d685d2dd91bbf09449 | 2023-05-21T18:23:30 | options-schema.json | 9 | 2024-05-27T06:43:25.738479Z | {
"$defs": {
"OperationValidationOptions": {
"additionalProperties": false,
"properties": {
"handleAllOperationResponses": {
"type": "integer"
},
"handleAllPathParams": {
"type": "integer"
},
"handleAllQueryParams": {
"type": "integer"
},
"validatePathParams": {
"type": "integer"
},
"validateQueryParams": {
"type": "integer"
},
"validateRequestBody": {
"type": "integer"
},
"validateResponses": {
"type": "integer"
}
},
"type": "object"
},
"Options": {
"additionalProperties": false,
"properties": {
"ExcludeOperations": {
"items": {
"type": "string"
},
"type": "array"
},
"defaultOperationValidation": {
"$ref": "#/$defs/OperationValidationOptions"
},
"handleAllContentTypes": {
"type": "integer"
},
"logLevel": {
"type": "integer"
},
"mustHandleAllOperations": {
"type": "integer"
},
"operationValidations": {
"patternProperties": {
".*": {
"$ref": "#/$defs/OperationValidationOptions"
}
},
"type": "object"
},
"recoverOnPanic": {
"type": "boolean"
}
},
"required": [
"ExcludeOperations"
],
"type": "object"
}
},
"$id": "https://github.com/piiano/cellotape/router/options",
"$ref": "#/$defs/Options",
"$schema": "http://json-schema.org/draft/2020-12/schema"
} | MIT | en |
piiano/cellotape | 2fccbee5b313af240acdbf566ef91d915ca96034 | 2022-09-01T09:17:45 | options-schema.json | 9 | 2024-05-27T06:43:25.738479Z | {
"$defs": {
"OperationValidationOptions": {
"additionalProperties": false,
"properties": {
"handleAllOperationResponses": {
"default": "propagate-error",
"enum": [
"propagate-error",
"print-warning",
"ignore"
],
"type": "string"
},
"handleAllPathParams": {
"default": "propagate-error",
"enum": [
"propagate-error",
"print-warning",
"ignore"
],
"type": "string"
},
"handleAllQueryParams": {
"default": "propagate-error",
"enum": [
"propagate-error",
"print-warning",
"ignore"
],
"type": "string"
},
"validatePathParams": {
"default": "propagate-error",
"enum": [
"propagate-error",
"print-warning",
"ignore"
],
"type": "string"
},
"validateQueryParams": {
"default": "propagate-error",
"enum": [
"propagate-error",
"print-warning",
"ignore"
],
"type": "string"
},
"validateRequestBody": {
"default": "propagate-error",
"enum": [
"propagate-error",
"print-warning",
"ignore"
],
"type": "string"
},
"validateResponses": {
"default": "propagate-error",
"enum": [
"propagate-error",
"print-warning",
"ignore"
],
"type": "string"
}
},
"type": "object"
},
"Options": {
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"defaultOperationValidation": {
"$ref": "#/$defs/OperationValidationOptions"
},
"handleAllContentTypes": {
"default": "propagate-error",
"enum": [
"propagate-error",
"print-warning",
"ignore"
],
"type": "string"
},
"logLevel": {
"default": "info",
"enum": [
"off",
"error",
"warn",
"info"
],
"type": "string"
},
"mustHandleAllOperations": {
"default": "propagate-error",
"enum": [
"propagate-error",
"print-warning",
"ignore"
],
"type": "string"
},
"operationValidations": {
"patternProperties": {
".*": {
"$ref": "#/$defs/OperationValidationOptions"
}
},
"type": "object"
},
"recoverOnPanic": {
"type": "boolean"
}
},
"type": "object"
}
},
"$id": "https://github.com/piiano/cellotape/router/options",
"$ref": "#/$defs/Options",
"$schema": "http://json-schema.org/draft/2020-12/schema"
} | MIT | en |
piiano/cellotape | 98128bc5d228aabaa2715c4178507673b5e61cbb | 2023-09-05T09:23:17 | options-schema.json | 9 | 2024-05-27T06:43:25.738479Z | {
"$defs": {
"OperationValidationOptions": {
"additionalProperties": false,
"properties": {
"handleAllOperationResponses": {
"type": "integer"
},
"handleAllPathParams": {
"type": "integer"
},
"handleAllQueryParams": {
"type": "integer"
},
"runtimeValidateResponses": {
"type": "integer"
},
"validatePathParams": {
"type": "integer"
},
"validateQueryParams": {
"type": "integer"
},
"validateRequestBody": {
"type": "integer"
},
"validateResponses": {
"type": "integer"
}
},
"type": "object"
},
"Options": {
"additionalProperties": false,
"properties": {
"ExcludeOperations": {
"items": {
"type": "string"
},
"type": "array"
},
"defaultOperationValidation": {
"$ref": "#/$defs/OperationValidationOptions"
},
"handleAllContentTypes": {
"type": "integer"
},
"logLevel": {
"type": "integer"
},
"mustHandleAllOperations": {
"type": "integer"
},
"operationValidations": {
"patternProperties": {
".*": {
"$ref": "#/$defs/OperationValidationOptions"
}
},
"type": "object"
},
"recoverOnPanic": {
"type": "boolean"
}
},
"required": [
"ExcludeOperations"
],
"type": "object"
}
},
"$id": "https://github.com/piiano/cellotape/router/options",
"$ref": "#/$defs/Options",
"$schema": "http://json-schema.org/draft/2020-12/schema"
} | MIT | en |
piiano/cellotape | 4d36e4b3709b92fb2a7d0d72be64ac67a6457231 | 2023-09-19T10:45:26 | options-schema.json | 9 | 2024-05-27T06:43:25.738479Z | {
"$defs": {
"OperationValidationOptions": {
"additionalProperties": false,
"properties": {
"contentTypesToSkipRuntimeValidation": {
"items": {
"type": "string"
},
"type": "array"
},
"handleAllOperationResponses": {
"type": "integer"
},
"handleAllPathParams": {
"type": "integer"
},
"handleAllQueryParams": {
"type": "integer"
},
"runtimeValidateResponses": {
"type": "integer"
},
"validatePathParams": {
"type": "integer"
},
"validateQueryParams": {
"type": "integer"
},
"validateRequestBody": {
"type": "integer"
},
"validateResponses": {
"type": "integer"
}
},
"type": "object"
},
"Options": {
"additionalProperties": false,
"properties": {
"ExcludeOperations": {
"items": {
"type": "string"
},
"type": "array"
},
"defaultOperationValidation": {
"$ref": "#/$defs/OperationValidationOptions"
},
"handleAllContentTypes": {
"type": "integer"
},
"logLevel": {
"type": "integer"
},
"mustHandleAllOperations": {
"type": "integer"
},
"operationValidations": {
"patternProperties": {
".*": {
"$ref": "#/$defs/OperationValidationOptions"
}
},
"type": "object"
},
"recoverOnPanic": {
"type": "boolean"
}
},
"required": [
"ExcludeOperations"
],
"type": "object"
}
},
"$id": "https://github.com/piiano/cellotape/router/options",
"$ref": "#/$defs/Options",
"$schema": "http://json-schema.org/draft/2020-12/schema"
} | MIT | en |
piiano/cellotape | fc5f0155e25a65ae1e83179c41c572e06e6f983a | 2023-12-18T14:18:42 | options-schema.json | 9 | 2024-05-27T06:43:25.738479Z | {
"$defs": {
"OperationValidationOptions": {
"additionalProperties": false,
"properties": {
"contentTypesToSkipRuntimeValidation": {
"items": {
"type": "string"
},
"type": "array"
},
"handleAllOperationResponses": {
"type": "integer"
},
"handleAllPathParams": {
"type": "integer"
},
"handleAllQueryParams": {
"type": "integer"
},
"runtimeValidateResponses": {
"type": "integer"
},
"validatePathParams": {
"type": "integer"
},
"validateQueryParams": {
"type": "integer"
},
"validateRequestBody": {
"type": "integer"
},
"validateResponses": {
"type": "integer"
}
},
"type": "object"
},
"Options": {
"additionalProperties": false,
"properties": {
"ExcludeOperations": {
"items": {
"type": "string"
},
"type": "array"
},
"defaultOperationValidation": {
"$ref": "#/$defs/OperationValidationOptions"
},
"handleAllContentTypes": {
"type": "integer"
},
"logLevel": {
"type": "integer"
},
"mustHandleAllOperations": {
"type": "integer"
},
"operationValidations": {
"patternProperties": {
".*": {
"$ref": "#/$defs/OperationValidationOptions"
}
},
"type": "object"
},
"recoverOnPanic": {
"type": "boolean"
}
},
"required": [
"ExcludeOperations"
],
"type": "object"
}
},
"$id": "https://github.com/piiano/cellotape/router/options",
"$ref": "#/$defs/Options",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | MIT | en |
piiano/cellotape | 79616b72196cbf4bd93c4c0062dc8fc58376216c | 2024-03-06T14:35:10 | options-schema.json | 9 | 2024-05-27T06:43:25.738479Z | {
"$defs": {
"OperationValidationOptions": {
"additionalProperties": false,
"properties": {
"contentTypesToSkipRuntimeValidation": {
"items": {
"type": "string"
},
"type": "array"
},
"handleAllOperationResponses": {
"type": "integer"
},
"handleAllPathParams": {
"type": "integer"
},
"handleAllQueryParams": {
"type": "integer"
},
"runtimeValidateResponses": {
"type": "integer"
},
"validatePathParams": {
"type": "integer"
},
"validateQueryParams": {
"type": "integer"
},
"validateRequestBody": {
"type": "integer"
},
"validateResponses": {
"type": "integer"
}
},
"type": "object"
},
"Options": {
"additionalProperties": false,
"properties": {
"ExcludeOperations": {
"items": {
"type": "string"
},
"type": "array"
},
"defaultOperationValidation": {
"$ref": "#/$defs/OperationValidationOptions"
},
"handleAllContentTypes": {
"type": "integer"
},
"logLevel": {
"type": "integer"
},
"mustHandleAllOperations": {
"type": "integer"
},
"operationValidations": {
"additionalProperties": {
"$ref": "#/$defs/OperationValidationOptions"
},
"type": "object"
},
"recoverOnPanic": {
"type": "boolean"
}
},
"required": [
"ExcludeOperations"
],
"type": "object"
}
},
"$id": "https://github.com/piiano/cellotape/router/options",
"$ref": "#/$defs/Options",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | MIT | en |
Pix4D/opf-spec | f3a0abfd011703d7414e73fc33d738b91bc4ade8 | 2023-05-23T11:53:53 | schema/property.schema.json | 59 | 2024-05-27T04:32:31.862387Z | {
"$id": "property.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"extensions": {
"$ref": "extension.schema.json"
}
},
"title": "property",
"type": "object"
} | CC-BY-4.0 | en |
Pix4D/opf-spec | f3a0abfd011703d7414e73fc33d738b91bc4ade8 | 2023-05-23T11:53:53 | schema/extension.schema.json | 59 | 2024-05-27T04:32:31.862387Z | {
"$id": "extension.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {
"type": "object"
},
"description": "JSON object with extension-specific objects. Extensions follow the naming convention VENDOR[_(team\u2758product)]_extname",
"properties": {},
"propertyNames": {
"pattern": "^([A-Z]+[A-Z0-9]*)_[a-z][a-z0-9_]+$"
},
"title": "Extension",
"type": "object"
} | CC-BY-4.0 | en |
JMayrbaeurl/opendigitaltwins-aas-azureservices | 0e9a635ce7255062d6b9fcb0f494694701a95e66 | 2022-02-02T14:11:00 | tools/aasx-cmdline/Resources/Schemas/schemaV201/aas.json | 17 | 2024-05-27T05:06:11.251998Z | {
"$id": "http://www.admin-shell.io/schema/json/v2.0.1",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"AccessControl": {
"properties": {
"accessPermissionRule": {
"items": {
"$ref": "#/definitions/AccessPermissionRule"
},
"type": "array"
},
"defaultEnvironmentAttributes": {
"$ref": "#/definitions/Reference"
},
"defaultPermissions": {
"$ref": "#/definitions/Reference"
},
"defaultSubjectAttributes": {
"$ref": "#/definitions/Reference"
},
"selectableEnvironmentAttributes": {
"$ref": "#/definitions/Reference"
},
"selectablePermissions": {
"$ref": "#/definitions/Reference"
},
"selectableSubjectAttributes": {
"$ref": "#/definitions/Reference"
}
},
"type": "object"
},
"AccessControlPolicyPoints": {
"properties": {
"policyAdministrationPoint": {
"$ref": "#/definitions/PolicyAdministrationPoint"
},
"policyDecisionPoint": {
"$ref": "#/definitions/PolicyDecisionPoint"
},
"policyEnforcementPoint": {
"$ref": "#/definitions/PolicyEnforcementPoint"
},
"policyInformationPoints": {
"$ref": "#/definitions/PolicyInformationPoints"
}
},
"required": [
"policyAdministrationPoint",
"policyDecisionPoint",
"policyEnforcementPoint"
],
"type": "object"
},
"AccessPermissionRule": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"$ref": "#/definitions/Qualifiable"
},
{
"properties": {
"permissionsPerObject": {
"items": {
"$ref": "#/definitions/PermissionsPerObject"
},
"type": "array"
},
"targetSubjectAttributes": {
"items": {
"$ref": "#/definitions/SubjectAttributes"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"targetSubjectAttributes"
]
}
]
},
"AdministrativeInformation": {
"properties": {
"revision": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"AnnotatedRelationshipElement": {
"allOf": [
{
"$ref": "#/definitions/RelationshipElement"
},
{
"properties": {
"annotation": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/Blob"
},
{
"$ref": "#/definitions/File"
},
{
"$ref": "#/definitions/MultiLanguageProperty"
},
{
"$ref": "#/definitions/Property"
},
{
"$ref": "#/definitions/Range"
},
{
"$ref": "#/definitions/ReferenceElement"
}
]
},
"type": "array"
}
}
}
]
},
"Asset": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"assetIdentificationModel": {
"$ref": "#/definitions/Reference"
},
"billOfMaterial": {
"$ref": "#/definitions/Reference"
},
"kind": {
"$ref": "#/definitions/AssetKind"
}
},
"required": [
"kind"
]
}
]
},
"AssetAdministrationShell": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"asset": {
"$ref": "#/definitions/Reference"
},
"conceptDictionaries": {
"items": {
"$ref": "#/definitions/ConceptDictionary"
},
"type": "array"
},
"derivedFrom": {
"$ref": "#/definitions/Reference"
},
"security": {
"$ref": "#/definitions/Security"
},
"submodels": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"views": {
"items": {
"$ref": "#/definitions/View"
},
"type": "array"
}
},
"required": [
"asset"
]
}
]
},
"AssetKind": {
"enum": [
"Type",
"Instance"
],
"type": "string"
},
"BasicEvent": {
"allOf": [
{
"$ref": "#/definitions/Event"
},
{
"properties": {
"observed": {
"$ref": "#/definitions/Reference"
}
},
"required": [
"observed"
]
}
]
},
"Blob": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"mimeType": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"mimeType"
]
}
]
},
"BlobCertificate": {
"allOf": [
{
"$ref": "#/definitions/Certificate"
},
{
"properties": {
"blobCertificate": {
"$ref": "#/definitions/Blob"
},
"containedExtension": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"lastCertificate": {
"type": "boolean"
}
}
}
]
},
"Capability": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
}
]
},
"Certificate": {
"type": "object"
},
"ConceptDescription": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"isCaseOf": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
}
}
]
},
"ConceptDictionary": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"conceptDescriptions": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
}
}
]
},
"Constraint": {
"properties": {
"modelType": {
"$ref": "#/definitions/ModelType"
}
},
"required": [
"modelType"
],
"type": "object"
},
"DataSpecificationContent": {
"oneOf": [
{
"$ref": "#/definitions/DataSpecificationIEC61360Content"
},
{
"$ref": "#/definitions/DataSpecificationPhysicalUnitContent"
}
]
},
"DataSpecificationIEC61360Content": {
"allOf": [
{
"$ref": "#/definitions/ValueObject"
},
{
"properties": {
"dataType": {
"enum": [
"DATE",
"STRING",
"STRING_TRANSLATABLE",
"REAL_MEASURE",
"REAL_COUNT",
"REAL_CURRENCY",
"BOOLEAN",
"URL",
"RATIONAL",
"RATIONAL_MEASURE",
"TIME",
"TIMESTAMP",
"INTEGER_COUNT",
"INTEGER_MEASURE",
"INTEGER_CURRENCY"
]
},
"definition": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"levelType": {
"items": {
"$ref": "#/definitions/LevelType"
},
"type": "array"
},
"preferredName": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"shortName": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"sourceOfDefinition": {
"type": "string"
},
"symbol": {
"type": "string"
},
"unit": {
"type": "string"
},
"unitId": {
"$ref": "#/definitions/Reference"
},
"valueFormat": {
"type": "string"
},
"valueList": {
"$ref": "#/definitions/ValueList"
}
},
"required": [
"preferredName"
],
"type": "object"
}
]
},
"DataSpecificationPhysicalUnitContent": {
"properties": {
"conversionFactor": {
"type": "string"
},
"definition": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"dinNotation": {
"type": "string"
},
"eceCode": {
"type": "string"
},
"eceName": {
"type": "string"
},
"nistName": {
"type": "string"
},
"registrationAuthorityId": {
"type": "string"
},
"siName": {
"type": "string"
},
"siNotation": {
"type": "string"
},
"sourceOfDefinition": {
"type": "string"
},
"supplier": {
"type": "string"
},
"unitName": {
"type": "string"
},
"unitSymbol": {
"type": "string"
}
},
"required": [
"unitName",
"unitSymbol",
"definition"
],
"type": "object"
},
"EmbeddedDataSpecification": {
"properties": {
"dataSpecification": {
"$ref": "#/definitions/Reference"
},
"dataSpecificationContent": {
"$ref": "#/definitions/DataSpecificationContent"
}
},
"required": [
"dataSpecification",
"dataSpecificationContent"
],
"type": "object"
},
"Entity": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"asset": {
"$ref": "#/definitions/Reference"
},
"entityType": {
"$ref": "#/definitions/EntityType"
},
"statements": {
"items": {
"$ref": "#/definitions/SubmodelElement"
},
"type": "array"
}
},
"required": [
"entityType"
]
}
]
},
"EntityType": {
"enum": [
"CoManagedEntity",
"SelfManagedEntity"
],
"type": "string"
},
"Event": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
}
]
},
"File": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"mimeType": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"mimeType"
]
}
]
},
"Formula": {
"allOf": [
{
"$ref": "#/definitions/Constraint"
},
{
"properties": {
"dependsOn": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
}
}
]
},
"HasDataSpecification": {
"properties": {
"embeddedDataSpecifications": {
"items": {
"$ref": "#/definitions/EmbeddedDataSpecification"
},
"type": "array"
}
},
"type": "object"
},
"HasSemantics": {
"properties": {
"semanticId": {
"$ref": "#/definitions/Reference"
}
},
"type": "object"
},
"Identifiable": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"properties": {
"administration": {
"$ref": "#/definitions/AdministrativeInformation"
},
"identification": {
"$ref": "#/definitions/Identifier"
}
},
"required": [
"identification"
]
}
]
},
"Identifier": {
"properties": {
"id": {
"type": "string"
},
"idType": {
"$ref": "#/definitions/KeyType"
}
},
"required": [
"id",
"idType"
],
"type": "object"
},
"Key": {
"properties": {
"idType": {
"$ref": "#/definitions/KeyType"
},
"local": {
"type": "boolean"
},
"type": {
"$ref": "#/definitions/KeyElements"
},
"value": {
"type": "string"
}
},
"required": [
"type",
"idType",
"value",
"local"
],
"type": "object"
},
"KeyElements": {
"enum": [
"Asset",
"AssetAdministrationShell",
"ConceptDescription",
"Submodel",
"AccessPermissionRule",
"AnnotatedRelationshipElement",
"BasicEvent",
"Blob",
"Capability",
"ConceptDictionary",
"DataElement",
"File",
"Entity",
"Event",
"MultiLanguageProperty",
"Operation",
"Property",
"Range",
"ReferenceElement",
"RelationshipElement",
"SubmodelElement",
"SubmodelElementCollection",
"View",
"GlobalReference",
"FragmentReference"
],
"type": "string"
},
"KeyType": {
"enum": [
"Custom",
"IRDI",
"IRI",
"IdShort",
"FragmentId"
],
"type": "string"
},
"LangString": {
"properties": {
"language": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"language",
"text"
],
"type": "object"
},
"LevelType": {
"enum": [
"Min",
"Max",
"Nom",
"Typ"
],
"type": "string"
},
"ModelType": {
"properties": {
"name": {
"$ref": "#/definitions/ModelTypes"
}
},
"required": [
"name"
],
"type": "object"
},
"ModelTypes": {
"enum": [
"Asset",
"AssetAdministrationShell",
"ConceptDescription",
"Submodel",
"AccessPermissionRule",
"AnnotatedRelationshipElement",
"BasicEvent",
"Blob",
"Capability",
"ConceptDictionary",
"DataElement",
"File",
"Entity",
"Event",
"MultiLanguageProperty",
"Operation",
"Property",
"Range",
"ReferenceElement",
"RelationshipElement",
"SubmodelElement",
"SubmodelElementCollection",
"View",
"GlobalReference",
"FragmentReference",
"Constraint",
"Formula",
"Qualifier"
],
"type": "string"
},
"ModelingKind": {
"enum": [
"Template",
"Instance"
],
"type": "string"
},
"MultiLanguageProperty": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"value": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"valueId": {
"$ref": "#/definitions/Reference"
}
}
}
]
},
"ObjectAttributes": {
"properties": {
"objectAttribute": {
"items": {
"$ref": "#/definitions/Property"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"Operation": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"inoutputVariable": {
"items": {
"$ref": "#/definitions/OperationVariable"
},
"type": "array"
},
"inputVariable": {
"items": {
"$ref": "#/definitions/OperationVariable"
},
"type": "array"
},
"outputVariable": {
"items": {
"$ref": "#/definitions/OperationVariable"
},
"type": "array"
}
}
}
]
},
"OperationVariable": {
"properties": {
"value": {
"oneOf": [
{
"$ref": "#/definitions/Blob"
},
{
"$ref": "#/definitions/File"
},
{
"$ref": "#/definitions/Capability"
},
{
"$ref": "#/definitions/Entity"
},
{
"$ref": "#/definitions/Event"
},
{
"$ref": "#/definitions/BasicEvent"
},
{
"$ref": "#/definitions/MultiLanguageProperty"
},
{
"$ref": "#/definitions/Operation"
},
{
"$ref": "#/definitions/Property"
},
{
"$ref": "#/definitions/Range"
},
{
"$ref": "#/definitions/ReferenceElement"
},
{
"$ref": "#/definitions/RelationshipElement"
},
{
"$ref": "#/definitions/SubmodelElementCollection"
}
]
}
},
"required": [
"value"
],
"type": "object"
},
"Permission": {
"properties": {
"kindOfPermission": {
"enum": [
"Allow",
"Deny",
"NotApplicable",
"Undefined"
],
"type": "string"
},
"permission": {
"$ref": "#/definitions/Reference"
}
},
"required": [
"permission",
"kindOfPermission"
],
"type": "object"
},
"PermissionsPerObject": {
"properties": {
"object": {
"$ref": "#/definitions/Reference"
},
"permission": {
"items": {
"$ref": "#/definitions/Permission"
},
"type": "array"
},
"targetObjectAttributes": {
"$ref": "#/definitions/ObjectAttributes"
}
},
"type": "object"
},
"PolicyAdministrationPoint": {
"properties": {
"externalAccessControl": {
"type": "boolean"
},
"localAccessControl": {
"$ref": "#/definitions/AccessControl"
}
},
"required": [
"externalAccessControl"
],
"type": "object"
},
"PolicyDecisionPoint": {
"properties": {
"externalPolicyDecisionPoints": {
"type": "boolean"
}
},
"required": [
"externalPolicyDecisionPoints"
],
"type": "object"
},
"PolicyEnforcementPoint": {
"properties": {
"externalPolicyEnforcementPoint": {
"type": "boolean"
}
},
"required": [
"externalPolicyEnforcementPoint"
],
"type": "object"
},
"PolicyInformationPoints": {
"properties": {
"externalInformationPoint": {
"type": "boolean"
},
"internalInformationPoint": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
},
"required": [
"externalInformationPoint"
],
"type": "object"
},
"Property": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"$ref": "#/definitions/ValueObject"
}
]
},
"Qualifiable": {
"properties": {
"qualifiers": {
"items": {
"$ref": "#/definitions/Constraint"
},
"type": "array"
}
},
"type": "object"
},
"Qualifier": {
"allOf": [
{
"$ref": "#/definitions/Constraint"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"$ref": "#/definitions/ValueObject"
},
{
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"Range": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"max": {
"type": "string"
},
"min": {
"type": "string"
},
"valueType": {
"enum": [
"anyUri",
"base64Binary",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"byte",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"unsignedByte",
"nonPositiveInteger",
"negativeInteger",
"double",
"duration",
"dayTimeDuration",
"yearMonthDuration",
"float",
"gDay",
"gMonth",
"gMonthDay",
"gYear",
"gYearMonth",
"hexBinary",
"NOTATION",
"QName",
"string",
"normalizedString",
"token",
"language",
"Name",
"NCName",
"ENTITY",
"ID",
"IDREF",
"NMTOKEN",
"time"
],
"type": "string"
}
},
"required": [
"valueType"
]
}
]
},
"Referable": {
"properties": {
"category": {
"type": "string"
},
"description": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"idShort": {
"type": "string"
},
"modelType": {
"$ref": "#/definitions/ModelType"
},
"parent": {
"$ref": "#/definitions/Reference"
}
},
"required": [
"idShort",
"modelType"
],
"type": "object"
},
"Reference": {
"properties": {
"keys": {
"items": {
"$ref": "#/definitions/Key"
},
"type": "array"
}
},
"required": [
"keys"
],
"type": "object"
},
"ReferenceElement": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"value": {
"$ref": "#/definitions/Reference"
}
}
}
]
},
"RelationshipElement": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"first": {
"$ref": "#/definitions/Reference"
},
"second": {
"$ref": "#/definitions/Reference"
}
},
"required": [
"first",
"second"
]
}
]
},
"Security": {
"properties": {
"accessControlPolicyPoints": {
"$ref": "#/definitions/AccessControlPolicyPoints"
},
"certificate": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/BlobCertificate"
}
]
},
"type": "array"
},
"requiredCertificateExtension": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
},
"required": [
"accessControlPolicyPoints"
],
"type": "object"
},
"SubjectAttributes": {
"properties": {
"subjectAttributes": {
"items": {
"$ref": "#/definitions/Reference"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"Submodel": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"$ref": "#/definitions/Qualifiable"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"properties": {
"kind": {
"$ref": "#/definitions/ModelingKind"
},
"submodelElements": {
"items": {
"$ref": "#/definitions/SubmodelElement"
},
"type": "array"
}
}
}
]
},
"SubmodelElement": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"$ref": "#/definitions/Qualifiable"
},
{
"properties": {
"kind": {
"$ref": "#/definitions/ModelingKind"
}
}
}
]
},
"SubmodelElementCollection": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"allowDuplicates": {
"type": "boolean"
},
"ordered": {
"type": "boolean"
},
"value": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/Blob"
},
{
"$ref": "#/definitions/File"
},
{
"$ref": "#/definitions/Capability"
},
{
"$ref": "#/definitions/Entity"
},
{
"$ref": "#/definitions/Event"
},
{
"$ref": "#/definitions/BasicEvent"
},
{
"$ref": "#/definitions/MultiLanguageProperty"
},
{
"$ref": "#/definitions/Operation"
},
{
"$ref": "#/definitions/Property"
},
{
"$ref": "#/definitions/Range"
},
{
"$ref": "#/definitions/ReferenceElement"
},
{
"$ref": "#/definitions/RelationshipElement"
},
{
"$ref": "#/definitions/SubmodelElementCollection"
}
]
},
"type": "array"
}
}
}
]
},
"ValueList": {
"properties": {
"valueReferencePairTypes": {
"items": {
"$ref": "#/definitions/ValueReferencePairType"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"valueReferencePairTypes"
],
"type": "object"
},
"ValueObject": {
"properties": {
"value": {
"type": "string"
},
"valueId": {
"$ref": "#/definitions/Reference"
},
"valueType": {
"enum": [
"anyUri",
"base64Binary",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"byte",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"unsignedByte",
"nonPositiveInteger",
"negativeInteger",
"double",
"duration",
"dayTimeDuration",
"yearMonthDuration",
"float",
"gDay",
"gMonth",
"gMonthDay",
"gYear",
"gYearMonth",
"hexBinary",
"NOTATION",
"QName",
"string",
"normalizedString",
"token",
"language",
"Name",
"NCName",
"ENTITY",
"ID",
"IDREF",
"NMTOKEN",
"time"
],
"type": "string"
}
},
"type": "object"
},
"ValueReferencePairType": {
"allOf": [
{
"$ref": "#/definitions/ValueObject"
}
]
},
"View": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"properties": {
"containedElements": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
}
}
]
}
},
"properties": {
"assetAdministrationShells": {
"items": {
"$ref": "#/definitions/AssetAdministrationShell"
},
"type": "array"
},
"assets": {
"items": {
"$ref": "#/definitions/Asset"
},
"type": "array"
},
"conceptDescriptions": {
"items": {
"$ref": "#/definitions/ConceptDescription"
},
"type": "array"
},
"submodels": {
"items": {
"$ref": "#/definitions/Submodel"
},
"type": "array"
}
},
"required": [
"assetAdministrationShells",
"submodels",
"assets",
"conceptDescriptions"
],
"title": "AssetAdministrationShellEnvironment",
"type": "object"
} | MIT | en |
KaotoIO/kaoto | ad7286f0b4facddd36a6687d30122a1ef399baa4 | 2023-08-21T18:23:58 | packages/ui/src/stubs/user-schema.json | 20 | 2024-05-27T09:27:12.425305Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"example-property": {
"defaultValue": "Example Property Default Value",
"description": "Example Property Description",
"properties": {
"allowEmptyDirectory": {
"description": "If the tar file has more than one entry, setting this option to true, allows to get the iterator even if the directory is empty",
"title": "Allow Empty Directory",
"type": "boolean"
},
"id": {
"description": "The id of this node",
"title": "Id",
"type": "string"
},
"maxDecompressedSize": {
"description": "Set the maximum decompressed size of a tar file (in bytes). The default value if not specified corresponds to 1 gigabyte. An IOException will be thrown if the decompressed size exceeds this amount. Set to -1 to disable setting a maximum decompressed size.",
"title": "Max Decompressed Size",
"type": "number"
},
"preservePathElements": {
"description": "If the file name contains path elements, setting this option to true, allows the path to be maintained in the tar file.",
"title": "Preserve Path Elements",
"type": "boolean"
},
"usingIterator": {
"description": "If the tar file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode.",
"title": "Using Iterator",
"type": "boolean"
}
},
"title": "Example Property Title",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
scalar-labs/scalar-ist | b90523b66bd40371555fdd33efc2376dca7058b9 | 2021-10-22T12:05:00 | contracts_and_functions/src/test/resources/validate_argument_test_schema.json | 13 | 2024-05-28T05:55:50.328964Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"description": "Register consent statement contract arguments schema",
"properties": {
"abstract": {
"pattern": "^(.+)$",
"type": "string"
},
"company_id": {
"format": "hostname",
"type": "string"
},
"consent_statement": {
"pattern": "(^.+)$",
"type": "string"
},
"created_at": {
"minimum": 0,
"type": "integer"
},
"data_retention_policy_id": {
"pattern": "^([a-zA-Z0-9]+)$",
"type": "string"
},
"data_set_schema_ids": {
"items": {
"pattern": "^([a-zA-Z0-9]+)$",
"type": "string"
},
"type": "array"
},
"organization_id": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"purpose_ids": {
"items": {
"pattern": "^([a-zA-Z0-9]+)$",
"type": "string"
},
"type": "array"
},
"third_party_ids": {
"items": {
"pattern": "^([a-zA-Z0-9]+)$",
"type": "string"
},
"type": "array"
},
"version": {
"pattern": "^([a-zA-Z0-9-]+)$",
"type": "string"
}
},
"required": [
"company_id",
"organization_id",
"abstract",
"version",
"data_set_schema_ids",
"purpose_ids",
"third_party_ids",
"consent_statement",
"created_at"
],
"type": "object"
} | Apache-2.0 | en |
scalar-labs/scalar-ist | b90523b66bd40371555fdd33efc2376dca7058b9 | 2021-10-22T12:05:00 | contracts_and_functions/src/main/resources/arguments/schema/update_consent_document_status.json | 13 | 2024-05-28T05:55:50.328964Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"company_id": {
"format": "hostname",
"type": "string"
},
"consent_statement_id": {
"pattern": "^consent_statement/[a-zA-Z0-9-.]+/[0-9]+$",
"type": "string"
},
"organization_id": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"status": {
"enum": [
"draft",
"published",
"reviewed",
"inactive"
],
"type": "string"
},
"updated_at": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"consent_statement_id",
"company_id",
"organization_id",
"status",
"updated_at"
],
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 50272545b92c79d92a5a31df1cb9d422ac1ba1d1 | 2022-09-02T07:06:43 | conceptual_model/schemas/identity.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "identity.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's identity",
"properties": {
"birthCountry": {
"$ref": "#/$defs/country_field",
"description": "The person's birth country"
},
"birthDate": {
"$ref": "#/$defs/date_field",
"description": "The person's birth date"
},
"birthPlace": {
"$ref": "#/$defs/city_field",
"description": "The person's birth place / city"
},
"firstName": {
"$ref": "#/$defs/string_field",
"description": "The person's first name"
},
"gender": {
"$ref": "#/$defs/gender_field",
"description": "The person's gender"
},
"lastName": {
"$ref": "#/$defs/string_field",
"description": "The person's last name"
},
"middleNames": {
"$ref": "#/$defs/string_field",
"description": "The person's middle names, separated by spaces"
}
},
"required": [],
"title": "Personal Identity",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | c5aabb6188d79826619add0806950083650ec022 | 2022-07-12T08:25:41 | conceptual_model/schemas/favorites.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"named_address_field": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The address name, like Home, Work...",
"type": "string"
},
"value": {
"$ref": "#/$defs/postal_address_field",
"description": "The address",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "favorites.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's favorite routing information",
"properties": {
"addresses": {
"description": "The person's favorite addresses",
"items": {
"$ref": "#/$defs/named_address_field"
},
"type": "array",
"uniqueItems": true
},
"transportationModes": {
"description": "The person's favorite transportation modes",
"items": {
"enum": [
"pedestrian",
"bus",
"metro",
"trolleybus",
"tram",
"water",
"funicular",
"cableway",
"car",
"bicycle",
"taxi",
"chauffeur",
"scooter",
"moped",
"motorcycle",
"carshare",
"train",
"coach",
"air"
],
"type": "string"
},
"type": "array"
}
},
"required": [],
"title": "Personal Routing Favorites",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 5af9e78e4587537d1d75ecce2ee3540a741dbb9a | 2022-07-12T06:45:16 | conceptual_model/schemas/driving-licence.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$comment": "TODO: add license type",
"$defs": {
"boolean_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
},
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "driving-license.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's driving license information",
"properties": {
"dateOfIssue": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license date of issue"
},
"dateOfValidity": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license maximum validity date"
},
"issuingCountry": {
"$ref": "#/$defs/country_field",
"description": "The person's driving license issuing country"
},
"number": {
"$ref": "#/$defs/string_field",
"description": "The person's driving license number"
}
},
"required": [],
"title": "Personal Driving License",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 18c4c94be67e4bf622cfb3ec4d053fb346c56d9b | 2022-06-13T16:29:23 | conceptual_model/schemas/personal-information.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
}
},
"$id": "personal-information.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's information",
"properties": {
"email": {
"$ref": "#/$defs/email_field",
"description": "The person's email"
},
"primaryPhoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's primary phone number"
},
"primaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's primary postal address"
},
"secondaryPhoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's secondary phone number"
},
"secondaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's secondary postal address"
}
},
"required": [],
"title": "Personal Information",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 228a1f0abfe2b0d5fae5c4936087dc2ef78c5bde | 2022-07-12T06:43:52 | conceptual_model/schemas/favorites.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"named_address_field": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The address name, like Home, Work...",
"type": "string"
},
"value": {
"$ref": "#/$defs/postal_address_field",
"description": "The address",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "favorites.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's favorite routing information",
"properties": {
"addresses": {
"description": "The person's favorite addresses",
"items": {
"$ref": "#/$defs/named_address_field"
},
"type": "array",
"uniqueItems": true
},
"transportationModes": {
"description": "The person's favorite transportation modes",
"items": {
"enum": [
"pedestrian",
"bus",
"metro",
"trolleyBus",
"tram",
"water",
"funicular",
"cableway",
"car",
"bicycle",
"taxi",
"chauffeur",
"scooter",
"moped",
"motorcycle",
"carshare",
"train",
"coach",
"air"
],
"type": "string"
},
"type": "array"
}
},
"required": [],
"title": "Personal Routing Favorites",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 0377a723df663e11be2970dd820950893fe8feeb | 2022-07-04T13:38:40 | conceptual_model/schemas/in-case-of-emergency-contacts.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"emergency_contact_field": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's email"
},
"firstName": {
"$ref": "#/$defs/string_field",
"description": "The person's first name"
},
"lastName": {
"$ref": "#/$defs/string_field",
"description": "The person's last name"
},
"phoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's phone number name"
}
},
"required": [
"lastName",
"firstName",
"phoneNumber"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "in-case-of-emergency-contacts.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's in-case-of-emergency contacts",
"properties": {
"contacts": {
"$comment": "Should be listed in the order of descending contact priority",
"description": "The person's in-case-of-emergency contacts",
"items": {
"$ref": "#/$defs/emergency_contact_field"
},
"type": "array",
"uniqueItems": true
}
},
"required": [],
"title": "Personal in-case-of-emergency contacts",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | f70ce9229d9f7a861678a990dd1bb1c0ec5cb468 | 2022-07-04T15:45:55 | conceptual_model/schemas/fr-mesri-information.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"boolean_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
},
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "fr-mesri-information.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's French MESRI information",
"properties": {
"scholarship": {
"$ref": "#/$defs/boolean_field",
"description": "If the person has scholarship"
},
"scholarshipEndDate": {
"$ref": "#/$defs/date_field",
"description": "The person's scholarship end date"
},
"scholarshipStartDate": {
"$ref": "#/$defs/date_field",
"description": "The person's scholarship start date"
},
"student": {
"$ref": "#/$defs/boolean_field",
"description": "If the person has student status"
},
"studentEndDate": {
"$ref": "#/$defs/date_field",
"description": "The person's student status end date"
},
"studentStartDate": {
"$ref": "#/$defs/date_field",
"description": "The person's student status start date"
}
},
"required": [],
"title": "Personal French MESRI information",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | bbe1f65df76e60b82abb2a5dc01f3bb3dd2f587b | 2022-07-04T13:34:30 | conceptual_model/schemas/in-case-of-emergency-contacts.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"emergency_contact_field": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's email"
},
"firstName": {
"$ref": "#/$defs/string_field",
"description": "The person's first name"
},
"lastName": {
"$ref": "#/$defs/string_field",
"description": "The person's last name"
},
"phoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's phone number name"
}
},
"required": [
"lastName",
"firstName",
"phoneNumber"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "in-case-of-emergency-contacts.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's in-case-of-emergency contacts",
"properties": {
"contacts": {
"$comment": "Should be listed in the order of descending contact priority",
"description": "The person's in-case-of-emergency contacts",
"items": {
"$ref": "#/$defs/emergency_contact_field"
},
"type": "array",
"uniqueItems": true
}
},
"required": [],
"title": "Personal in-case-of-emergency contacts",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 5474b42ccb16edb3f785fe05c741ec4a82056392 | 2022-07-04T12:52:23 | conceptual_model/schemas/personal-information.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"country_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "personal-information.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's information",
"properties": {
"email": {
"$ref": "#/$defs/email_field",
"description": "The person's email"
},
"primaryPhoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's primary phone number"
},
"primaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's primary postal address"
},
"secondaryPhoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's secondary phone number"
},
"secondaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's secondary postal address"
}
},
"required": [],
"title": "Personal Information",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | d8ea4fe381db397ab41423d7131368acf59c028d | 2022-07-04T15:39:33 | conceptual_model/schemas/fr-dgfip-information.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$comment": "TODO: improve information on tax notices, add information of persons attached to declarants",
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"dgfip_identity_field": {
"additionalProperties": false,
"properties": {
"birthCountry": {
"$ref": "#/$defs/country_field",
"description": "The person's birth country"
},
"birthDate": {
"$ref": "#/$defs/date_field",
"description": "The person's birth date"
},
"birthName": {
"$ref": "#/$defs/string_field",
"description": "The person's last name"
},
"birthPlace": {
"$ref": "#/$defs/city_field",
"description": "The person's birth place / city"
},
"email": {
"$ref": "#/$defs/email_field",
"description": "The person's email"
},
"firstName": {
"$ref": "#/$defs/string_field",
"description": "The person's first name"
},
"lastName": {
"$ref": "#/$defs/string_field",
"description": "The person's last name"
},
"middleNames": {
"$comment": "TODO: check if this is the right model",
"$ref": "#/$defs/string_field",
"description": "The person's middle names, separated by spaces"
},
"primaryPhoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's primary phone number"
},
"primaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's primary postal address"
},
"secondaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's secondary postal address"
}
},
"required": [
"value"
],
"type": "object"
},
"dgfip_tax_notice_field": {
"additionalProperties": false,
"properties": {
"declarationYear": {
"$ref": "#/$defs/integer_field",
"description": "The declaration year"
},
"grossIncome": {
"$ref": "#/$defs/number_field",
"description": "The overall gross income"
},
"numberOfShares": {
"$ref": "#/$defs/integer_field",
"description": "The number of shares"
},
"referenceTaxIncome": {
"$ref": "#/$defs/number_field",
"description": "The reference tax income"
},
"taxAmount": {
"$ref": "#/$defs/number_field",
"description": "The tax amount"
},
"taxableIncome": {
"$ref": "#/$defs/number_field",
"description": "The taxable income"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"integer_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "fr-dgfip-information.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's French DGFIP information",
"properties": {
"declarant1": {
"$ref": "#/$defs/dgfip_identity_field",
"description": "The first declarant information"
},
"declarant2": {
"$ref": "#/$defs/dgfip_identity_field",
"description": "The second declarant information"
},
"taxNotices": {
"description": "Tax notices",
"items": {
"$ref": "#/$defs/dgfip_tax_notice_field"
},
"type": "array",
"uniqueItems": true
}
},
"required": [],
"title": "Personal French DGFIP information",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | a9a02e6a71e4d221f71bdb452cf422b19222e54b | 2022-09-02T07:06:29 | conceptual_model/schemas/in-case-of-emergency-contacts.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"emergency_contact_field": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's email"
},
"firstName": {
"$ref": "#/$defs/string_field",
"description": "The person's first name"
},
"lastName": {
"$ref": "#/$defs/string_field",
"description": "The person's last name"
},
"phoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's phone number name"
}
},
"required": [
"lastName",
"firstName",
"phoneNumber"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "in-case-of-emergency-contacts.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's in-case-of-emergency contacts",
"properties": {
"contacts": {
"$comment": "Should be listed in the order of descending contact priority",
"description": "The person's in-case-of-emergency contacts",
"items": {
"$ref": "#/$defs/emergency_contact_field"
},
"type": "array",
"uniqueItems": true
}
},
"required": [],
"title": "Personal in-case-of-emergency contacts",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 20b0641b6ac7452d48e00b5e25d38bc5da274cb3 | 2022-07-05T07:55:55 | conceptual_model/schemas/favorites.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"named_address_field": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The address name, like Home, Work...",
"type": "string"
},
"value": {
"$ref": "#/$defs/postal_address_field",
"description": "The address",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "favorites.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's favorite routing information",
"properties": {
"addresses": {
"description": "The person's favorite addresses",
"items": {
"$ref": "#/$defs/named_address_field"
},
"type": "array",
"uniqueItems": true
},
"transportationModes": {
"description": "The person's favorite transportation modes",
"items": {
"enum": [
"pedestrian",
"public-transport",
"car",
"bicycle",
"taxi",
"scooter",
"motorcycle",
"carshare",
"train",
"coach"
],
"type": "string"
},
"type": "array"
}
},
"required": [],
"title": "Personal Routing Favorites",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 284b073dc55e2ebb8c842c4eea2566da4d26702c | 2022-07-04T15:44:40 | conceptual_model/schemas/fr-mesri-information.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "fr-mesri-information.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's French MESRI information",
"properties": {
"scholarship": {
"$ref": "#/$defs/boolean_field",
"description": "If the person has scholarship"
},
"scholarshipEndDate": {
"$ref": "#/$defs/date_field",
"description": "The person's scholarship end date"
},
"scholarshipStartDate": {
"$ref": "#/$defs/date_field",
"description": "The person's scholarship start date"
},
"student": {
"$ref": "#/$defs/boolean_field",
"description": "If the person has student status"
},
"studentEndDate": {
"$ref": "#/$defs/date_field",
"description": "The person's student status end date"
},
"studentStartDate": {
"$ref": "#/$defs/date_field",
"description": "The person's student status start date"
}
},
"required": [],
"title": "Personal French MESRI information",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 0377a723df663e11be2970dd820950893fe8feeb | 2022-07-04T13:38:40 | conceptual_model/schemas/favorites.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"named_address_field": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The address name, like Home, Work...",
"type": "string"
},
"value": {
"$ref": "#/$defs/postal_address_field",
"description": "The address",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "favorites.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's favorite routing information",
"properties": {
"addresses": {
"description": "The person's favorite addresses",
"items": {
"$ref": "#/$defs/named_address_field"
},
"type": "array",
"uniqueItems": true
}
},
"required": [],
"title": "Personal Routing Favorites",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | e8389f0cb09ecd938072910ebfd1607f6c4316f7 | 2022-07-04T13:00:02 | conceptual_model/schemas/personal-information.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "personal-information.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's information",
"properties": {
"email": {
"$ref": "#/$defs/email_field",
"description": "The person's email"
},
"primaryPhoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's primary phone number"
},
"primaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's primary postal address"
},
"secondaryPhoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's secondary phone number"
},
"secondaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's secondary postal address"
}
},
"required": [],
"title": "Personal Information",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 8ea3ec1a68798d639985e557064faacae4bfc156 | 2022-07-05T08:43:24 | conceptual_model/schemas/favorites.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"named_address_field": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The address name, like Home, Work...",
"type": "string"
},
"value": {
"$ref": "#/$defs/postal_address_field",
"description": "The address",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "favorites.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's favorite routing information",
"properties": {
"addresses": {
"description": "The person's favorite addresses",
"items": {
"$ref": "#/$defs/named_address_field"
},
"type": "array",
"uniqueItems": true
},
"transportationModes": {
"description": "The person's favorite transportation modes",
"items": {
"enum": [
"pedestrian",
"public-transport",
"car",
"bicycle",
"taxi",
"chauffeur",
"scooter",
"moped",
"motorcycle",
"carshare",
"train",
"coach"
],
"type": "string"
},
"type": "array"
}
},
"required": [],
"title": "Personal Routing Favorites",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | a42702cf98a727cfa1fb84a5acd546109e50aaf4 | 2022-07-04T13:27:30 | conceptual_model/schemas/driving-licence.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "driving-license.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's driving license information",
"properties": {
"dateOfIssue": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license date of issue"
},
"dateOfValidity": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license maximum validity date"
},
"issuingCountry": {
"$ref": "#/$defs/country_field",
"description": "The person's driving license issuing country"
},
"number": {
"$ref": "#/$defs/string_field",
"description": "The person's driving license number"
}
},
"required": [],
"title": "Personal Driving License",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | b7ac71e00124bce3e50ea9b56fc3e56c5ab8a925 | 2022-07-04T15:16:37 | conceptual_model/schemas/driving-licence.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"boolean_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
},
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "driving-license.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's driving license information",
"properties": {
"dateOfIssue": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license date of issue"
},
"dateOfValidity": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license maximum validity date"
},
"invalid": {
"$ref": "#/$defs/boolean_field",
"description": "If the person's driving license is invalid"
},
"issuingCountry": {
"$ref": "#/$defs/country_field",
"description": "The person's driving license issuing country"
},
"number": {
"$ref": "#/$defs/string_field",
"description": "The person's driving license number"
}
},
"required": [],
"title": "Personal Driving License",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | e605cc305a58e6c1d86dc82e9234457c0b7b8be2 | 2022-06-21T07:32:59 | conceptual_model/schemas/personal-information.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"country_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"source",
"certificationDate"
],
"type": "object"
}
},
"$id": "personal-information.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's information",
"properties": {
"email": {
"$ref": "#/$defs/email_field",
"description": "The person's email"
},
"primaryPhoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's primary phone number"
},
"primaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's primary postal address"
},
"secondaryPhoneNumber": {
"$ref": "#/$defs/phone_number_field",
"description": "The person's secondary phone number"
},
"secondaryPostalAddress": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's secondary postal address"
}
},
"required": [],
"title": "Personal Information",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | c7a4b7ff9a2ed8d07b054c4853a9181fe647f9e6 | 2022-07-05T07:58:11 | conceptual_model/schemas/favorites.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"named_address_field": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The address name, like Home, Work...",
"type": "string"
},
"value": {
"$ref": "#/$defs/postal_address_field",
"description": "The address",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "favorites.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's favorite routing information",
"properties": {
"addresses": {
"description": "The person's favorite addresses",
"items": {
"$ref": "#/$defs/named_address_field"
},
"type": "array",
"uniqueItems": true
},
"transportationModes": {
"description": "The person's favorite transportation modes",
"items": {
"enum": [
"pedestrian",
"public-transport",
"car",
"bicycle",
"taxi",
"chauffeur",
"scooter",
"motorcycle",
"carshare",
"train",
"coach"
],
"type": "string"
},
"type": "array"
}
},
"required": [],
"title": "Personal Routing Favorites",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | d9926356388e5d36d1e2282fb7c83ea3ed48290f | 2022-07-04T15:17:38 | conceptual_model/schemas/driving-licence.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$comment": "TODO: add license type",
"$defs": {
"boolean_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
},
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "driving-license.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's driving license information",
"properties": {
"dateOfIssue": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license date of issue"
},
"dateOfValidity": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license maximum validity date"
},
"invalid": {
"$ref": "#/$defs/boolean_field",
"description": "If the person's driving license is invalid"
},
"issuingCountry": {
"$ref": "#/$defs/country_field",
"description": "The person's driving license issuing country"
},
"number": {
"$ref": "#/$defs/string_field",
"description": "The person's driving license number"
}
},
"required": [],
"title": "Personal Driving License",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | c9db24d104b07373c02791aea71ccf1de961b42b | 2022-07-04T15:21:00 | conceptual_model/schemas/fr-caf-information.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "fr-caf-information.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's French CAF information",
"properties": {
"address": {
"$ref": "#/$defs/postal_address_field",
"description": "The person's main postal address"
},
"birthDate": {
"$ref": "#/$defs/date_field",
"description": "The person's birth date"
},
"familyQuotient": {
"$ref": "#/$defs/string_field",
"description": "The person's family quotient"
},
"firstName": {
"$ref": "#/$defs/string_field",
"description": "The person's first name"
},
"lastName": {
"$ref": "#/$defs/string_field",
"description": "The person's last name"
},
"middleNames": {
"$comment": "TODO: check if this is the right model",
"$ref": "#/$defs/string_field",
"description": "The person's middle names, separated by spaces"
},
"recipientNumber": {
"$ref": "#/$defs/string_field",
"description": "The person's recipient number"
}
},
"required": [],
"title": "Personal French CAF information",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 0377a723df663e11be2970dd820950893fe8feeb | 2022-07-04T13:38:40 | conceptual_model/schemas/driving-licence.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"mobile": {
"$comment": "if the telephone is mobile, meaning it can receive SMS",
"type": "boolean"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value",
"mobile"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "driving-license.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's driving license information",
"properties": {
"dateOfIssue": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license date of issue"
},
"dateOfValidity": {
"$ref": "#/$defs/date_field",
"description": "The person's driving license maximum validity date"
},
"issuingCountry": {
"$ref": "#/$defs/country_field",
"description": "The person's driving license issuing country"
},
"number": {
"$ref": "#/$defs/string_field",
"description": "The person's driving license number"
}
},
"required": [],
"title": "Personal Driving License",
"type": "object"
} | Apache-2.0 | en |
fabmob/CMS | 9584d9f6dd4d47bf503dd30120624ad3dd5e2503 | 2022-07-04T13:16:11 | conceptual_model/schemas/favorites.schema.json | 9 | 2024-05-27T06:06:54.833841Z | {
"$defs": {
"city_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"inseeValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"inseeValue": {
"$comment": "French INSEE code for cities",
"maxLength": 5,
"minLength": 5,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"country_field": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name"
]
},
{
"required": [
"isoValue"
]
}
],
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"isoValue": {
"$comment": "ISO 3166-1 alpha-3",
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"date_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "date",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"email_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"format": "email",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"gender_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "ISO/IEC 5218",
"enum": [
0,
1,
2,
9
],
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"named_address_field": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The address name, like Home, Work...",
"type": "string"
},
"value": {
"$ref": "#/$defs/postal_address_field",
"description": "The address",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"phone_number_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "E.164 standard",
"pattern": "^\\+?[1-9]\\d{1,14}$",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"postal_address_field": {
"$comment": "Rough implementation of the AFNOR NF Z 10-011 standard",
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"$comment": "At least first line is expected to be filled",
"additionalProperties": false,
"properties": {
"line1": {
"maxLength": 38,
"type": "string"
},
"line2": {
"maxLength": 38,
"type": "string"
},
"line3": {
"maxLength": 38,
"type": "string"
},
"line4": {
"maxLength": 38,
"type": "string"
},
"line5": {
"maxLength": 38,
"type": "string"
},
"line6": {
"maxLength": 38,
"type": "string"
},
"line7": {
"maxLength": 38,
"type": "string"
}
},
"required": [
"line1"
],
"type": "object"
}
},
"required": [
"value"
],
"type": "object"
},
"string_field": {
"additionalProperties": false,
"properties": {
"certificationDate": {
"format": "date-time",
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"$id": "favorites.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A person's favorite routing information",
"properties": {
"addresses": {
"description": "The person's favorite addresses",
"items": {
"$ref": "#/$defs/named_address_field"
},
"type": "array",
"uniqueItems": true
}
},
"required": [],
"title": "Personal Routing Favorites",
"type": "object"
} | Apache-2.0 | en |
lalcebo/json-schema | 2531ca7168d7ad333a99a2235b797210fbc7da7d | 2023-03-06T10:26:55 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | b831425b76660acc9a6ab1211ad982974bcdea0b | 2023-03-06T16:50:24 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | b1639f9f3b067cc48501bbf9f4c206e8edf1f7ed | 2023-03-15T08:31:33 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#/AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "components/iam.json#/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/AwsStepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 4494b7ce8d34a9fc730cafdfb94ba968b5632ab4 | 2023-03-06T04:51:05 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"Aws.CloudFormationResource": {
"properties": {
"DeletionPolicy": {
"type": "string"
},
"DependsOn": {
"anyOf": [
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Properties": {
"additionalProperties": {},
"type": "object"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.CloudwatchEvent.InternalEvent": {
"properties": {
"account": {
"type": "string"
},
"detail": {
"type": "object"
},
"detail-type": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"id": {
"type": "string"
},
"region": {
"type": "string"
},
"resources": {
"description": "This is an array of arns",
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"time": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"source"
]
},
"Aws.Destinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"Aws.Detail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"Aws.Environment": {
"additionalProperties": {},
"type": "object"
},
"Aws.HttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"Aws.HttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/Aws.HttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Aws.IdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Input": {
"additionalProperties": {},
"type": "object"
},
"Aws.NamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Quota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"Aws.ResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"Aws.RollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/Aws.RollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"Aws.RollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.S3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"Aws.StackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"Aws.Tags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Aws.Throttle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"Aws.Tracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"Aws.UsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/Aws.Quota"
},
"throttle": {
"$ref": "#/definitions/Aws.Throttle"
}
},
"type": "object"
},
"Aws.Vpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"Aws.WebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchEvent": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"event": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Aws.CloudwatchEvent.InternalEvent"
}
]
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "#/definitions/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/Aws.Destinations"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/Aws.HttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/Aws.NamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/Aws.IdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/Aws.Detail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/Aws.RollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/Aws.StackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/Aws.Tags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/Aws.Tracing"
},
"usagePlan": {
"$ref": "#/definitions/Aws.UsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsResources": {
"oneOf": [
{
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/Aws.S3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/Aws.WebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/AwsResources"
},
{
"items": {
"$ref": "#/definitions/AwsResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 77929afa95d0a2ed73b490be0810199c3101a5bd | 2023-03-07T17:23:49 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#/AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/AwsStepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 2efcf4e2f44956000120bd0f69a2a3db11e8b582 | 2023-03-06T04:51:05 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsResources": {
"oneOf": [
{
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/AwsResources"
},
{
"items": {
"$ref": "#/definitions/AwsResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 6a297b0d07f19a5f8ff88e1e9c9fe3342279cd38 | 2023-03-07T02:49:04 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | cc14fcc77c8dab9ea68884025f377d389b9f1a23 | 2023-03-07T03:26:43 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#/AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 02f478520b757e78f2949a53e81fdcc9afdf4581 | 2024-02-07T20:36:51 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"anyOf": [
{
"$ref": "components/events.json#/AwsSqs"
},
{
"type": "string"
}
]
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#/AwsHttpApi"
},
"iam": {
"$ref": "components/iam.json#/AwsIamConfiguration"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "components/iam.json#/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"anyOf": [
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
{
"type": "string"
}
]
},
"type": "array"
},
"subnetIds": {
"items": {
"anyOf": [
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
{
"type": "string"
}
]
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/AwsStepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.